Package org.apache.poi.xssf.usermodel
Class XSSFDataValidationConstraint
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFDataValidationConstraint
- All Implemented Interfaces:
DataValidationConstraint
- Author:
- Radhakrishnan J
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.DataValidationConstraint
DataValidationConstraint.OperatorType, DataValidationConstraint.ValidationType -
Constructor Summary
ConstructorsConstructorDescriptionXSSFDataValidationConstraint(int validationType, int operator, String formula1) XSSFDataValidationConstraint(int validationType, int operator, String formula1, String formula2) This is the constructor called using the OOXML raw data.XSSFDataValidationConstraint(int validationType, String formula1) XSSFDataValidationConstraint(String[] explicitListOfValues) list literal constructor -
Method Summary
Modifier and TypeMethodDescriptionString[]If validation type isDataValidationConstraint.ValidationType.LISTandformula1was comma-separated literal values rather than a range or named range, returns list of literal values.intintprotected static booleanisFormulaEmpty(String formula1) protected static StringremoveLeadingEquals(String formula1) voidsetExplicitListValues(String[] explicitListValues) voidsetFormula1(String formula1) Sets a formula for expression 1.voidsetFormula2(String formula2) Sets a formula for expression 2.voidsetOperator(int operator) Sets the comparison operator for this constraintvoidvalidate()
-
Constructor Details
-
XSSFDataValidationConstraint
list literal constructor -
XSSFDataValidationConstraint
-
XSSFDataValidationConstraint
-
XSSFDataValidationConstraint
public XSSFDataValidationConstraint(int validationType, int operator, String formula1, String formula2) This is the constructor called using the OOXML raw data. Excel overloads formula1 to also encode explicit value lists, so this constructor has to check for and parse that syntax.- Parameters:
validationType-operator-formula1- Overloaded: formula1 or list of explicit valuesformula2- (formula1 is a list of explicit values, this is ignored: usenull)
-
-
Method Details
-
getExplicitListValues
Description copied from interface:DataValidationConstraintIf validation type isDataValidationConstraint.ValidationType.LISTandformula1was comma-separated literal values rather than a range or named range, returns list of literal values. Otherwise returnsnull.- Specified by:
getExplicitListValuesin interfaceDataValidationConstraint
-
getFormula1
- Specified by:
getFormula1in interfaceDataValidationConstraint- Returns:
- the formula for expression 1. May be
null
-
getFormula2
- Specified by:
getFormula2in interfaceDataValidationConstraint- Returns:
- the formula for expression 2. May be
null
-
getOperator
public int getOperator()- Specified by:
getOperatorin interfaceDataValidationConstraint- Returns:
- the operator used for this constraint
- See Also:
-
getValidationType
public int getValidationType()- Specified by:
getValidationTypein interfaceDataValidationConstraint- Returns:
- data validation type of this constraint
- See Also:
-
setExplicitListValues
- Specified by:
setExplicitListValuesin interfaceDataValidationConstraint
-
setFormula1
Description copied from interface:DataValidationConstraintSets a formula for expression 1.- Specified by:
setFormula1in interfaceDataValidationConstraint
-
removeLeadingEquals
-
isFormulaEmpty
-
setFormula2
Description copied from interface:DataValidationConstraintSets a formula for expression 2.- Specified by:
setFormula2in interfaceDataValidationConstraint
-
setOperator
public void setOperator(int operator) Description copied from interface:DataValidationConstraintSets the comparison operator for this constraint- Specified by:
setOperatorin interfaceDataValidationConstraint- See Also:
-
validate
public void validate() -
prettyPrint
-