org.apache.poi.hssf.usermodel
Class DVConstraint

java.lang.Object
  extended by org.apache.poi.hssf.usermodel.DVConstraint

public class DVConstraint
extends java.lang.Object

Author:
Josh Micich

Nested Class Summary
static class DVConstraint.OperatorType
          Condition operator enum
static class DVConstraint.ValidationType
          ValidationType enum
 
Method Summary
static DVConstraint createCustomFormulaConstraint(java.lang.String formula)
           
static DVConstraint createDateConstraint(int comparisonOperator, java.lang.String expr1, java.lang.String expr2, java.lang.String dateFormat)
          Creates a date based data validation constraint.
static DVConstraint createExplicitListConstraint(java.lang.String[] explicitListValues)
           
static DVConstraint createFormulaListConstraint(java.lang.String listFormula)
           
static DVConstraint createNumericConstraint(int validationType, int comparisonOperator, java.lang.String expr1, java.lang.String expr2)
          Creates a number based data validation constraint.
static DVConstraint createTimeConstraint(int comparisonOperator, java.lang.String expr1, java.lang.String expr2)
          Creates a time based data validation constraint.
 java.lang.String[] getExplicitListValues()
           
 java.lang.String getFormula1()
           
 java.lang.String getFormula2()
           
 int getOperator()
           
 int getValidationType()
           
 java.lang.Double getValue1()
           
 java.lang.Double getValue2()
           
 boolean isExplicitList()
          Convenience method
 boolean isListValidationType()
          Convenience method
 void setExplicitListValues(java.lang.String[] explicitListValues)
           
 void setFormula1(java.lang.String formula1)
          Sets a formula for expression 1.
 void setFormula2(java.lang.String formula2)
          Sets a formula for expression 2.
 void setOperator(int operator)
          Sets the comparison operator for this constraint
 void setValue1(double value1)
          Sets a numeric value for expression 1.
 void setValue2(double value2)
          Sets a numeric value for expression 2.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createNumericConstraint

public static DVConstraint createNumericConstraint(int validationType,
                                                   int comparisonOperator,
                                                   java.lang.String expr1,
                                                   java.lang.String expr2)
Creates a number based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted number values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted number.

Parameters:
validationType - one of DVConstraint.ValidationType.ANY, DVConstraint.ValidationType.DECIMAL, DVConstraint.ValidationType.INTEGER, DVConstraint.ValidationType.TEXT_LENGTH
comparisonOperator - any constant from DVConstraint.OperatorType enum
expr1 - date formula (when first char is '=') or formatted number value
expr2 - date formula (when first char is '=') or formatted number value

createFormulaListConstraint

public static DVConstraint createFormulaListConstraint(java.lang.String listFormula)

createExplicitListConstraint

public static DVConstraint createExplicitListConstraint(java.lang.String[] explicitListValues)

createTimeConstraint

public static DVConstraint createTimeConstraint(int comparisonOperator,
                                                java.lang.String expr1,
                                                java.lang.String expr2)
Creates a time based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted time values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted time. To parse formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to Excel which uses the default time format from the OS.

Parameters:
comparisonOperator - constant from DVConstraint.OperatorType enum
expr1 - date formula (when first char is '=') or formatted time value
expr2 - date formula (when first char is '=') or formatted time value

createDateConstraint

public static DVConstraint createDateConstraint(int comparisonOperator,
                                                java.lang.String expr1,
                                                java.lang.String expr2,
                                                java.lang.String dateFormat)
Creates a date based data validation constraint. The text values entered for expr1 and expr2 can be either standard Excel formulas or formatted date values. If the expression starts with '=' it is parsed as a formula, otherwise it is parsed as a formatted date (Excel uses the same convention). To parse formatted dates, a date format needs to be specified. This is contrary to Excel which uses the default short date format from the OS.

Parameters:
comparisonOperator - constant from DVConstraint.OperatorType enum
expr1 - date formula (when first char is '=') or formatted date value
expr2 - date formula (when first char is '=') or formatted date value
dateFormat - ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD" otherwise any other valid argument for SimpleDateFormat can be used
See Also:
SimpleDateFormat

createCustomFormulaConstraint

public static DVConstraint createCustomFormulaConstraint(java.lang.String formula)

getValidationType

public int getValidationType()
Returns:
data validation type of this constraint
See Also:
DVConstraint.ValidationType

isListValidationType

public boolean isListValidationType()
Convenience method

Returns:
true if this constraint is a 'list' validation

isExplicitList

public boolean isExplicitList()
Convenience method

Returns:
true if this constraint is a 'list' validation with explicit values

getOperator

public int getOperator()
Returns:
the operator used for this constraint
See Also:
DVConstraint.OperatorType

setOperator

public void setOperator(int operator)
Sets the comparison operator for this constraint

See Also:
DVConstraint.OperatorType

getExplicitListValues

public java.lang.String[] getExplicitListValues()

setExplicitListValues

public void setExplicitListValues(java.lang.String[] explicitListValues)

getFormula1

public java.lang.String getFormula1()
Returns:
the formula for expression 1. May be null

setFormula1

public void setFormula1(java.lang.String formula1)
Sets a formula for expression 1.


getFormula2

public java.lang.String getFormula2()
Returns:
the formula for expression 2. May be null

setFormula2

public void setFormula2(java.lang.String formula2)
Sets a formula for expression 2.


getValue1

public java.lang.Double getValue1()
Returns:
the numeric value for expression 1. May be null

setValue1

public void setValue1(double value1)
Sets a numeric value for expression 1.


getValue2

public java.lang.Double getValue2()
Returns:
the numeric value for expression 2. May be null

setValue2

public void setValue2(double value2)
Sets a numeric value for expression 2.



Copyright 2011 The Apache Software Foundation or its licensors, as applicable.