Apache POI - Common 5.3.0 · org.apache.poi.hssf.usermodel.DVConstraint

Modifier and Type	Class and Description
pack-priv static class	DVConstraint.FormulaPair
private static class	DVConstraint.FormulaValuePair

Modifier and Type	Field and Description
private String[]	_explicitListValues
private String	_formula1
private String	_formula2
private int	_operator
private final int	_validationType
private Double	_value1
private Double	_value2

Access	Constructor and Description
private	DVConstraint(int validationType, int comparisonOperator, String formulaA, String formulaB, Double value1, Double value2, String[] explicitListValues)
private	DVConstraint(String listFormula, String[] explicitListValues) Creates a list constraint

Method Summary

Modifier and Type	Method and Description
private static Double	Returns: `null` if timeStr is `null` convertDate(String dateStr, SimpleDateFormat pass `null` for default YYYYMMDD dateFormat)
private static Ptg[]	Returns: The parsed token array representing the formula or value specified. Empty array if both formula and value are `null` convertDoubleFormula(String formula, Double value, HSSFSheet sheet)
private static Double	Returns: `null` if numberStr is `null` convertNumber(String numberStr)
private static Double	Returns: `null` if timeStr is `null` convertTime(String timeStr)
public static DVConstraint	createCustomFormulaConstraint(String formula)
public static DVConstraint	createDateConstraint(int constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum comparisonOperator, String date formula (when first char is '=') or formatted date value expr1, String date formula (when first char is '=') or formatted date value expr2, String ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD" otherwise any other valid argument for `SimpleDateFormat` can be used dateFormat) Creates a date based data validation constraint.
pack-priv static DVConstraint	createDVConstraint(DVRecord dvRecord, FormulaRenderingWorkbook book)
public static DVConstraint	createExplicitListConstraint(String[] explicitListValues)
public static DVConstraint	createFormulaListConstraint(String listFormula)
pack-priv DVConstraint.FormulaPair	Returns: both parsed formulas (for expression 1 and 2). createFormulas(HSSFSheet sheet)
private Ptg[]	createListFormula(HSSFSheet sheet)
public static DVConstraint	createNumericConstraint(int one of `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#ANY`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#DECIMAL`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#INTEGER`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#TEXT_LENGTH` validationType, int any constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum comparisonOperator, String date formula (when first char is '=') or formatted number value expr1, String date formula (when first char is '=') or formatted number value expr2) Creates a number based data validation constraint.
public static DVConstraint	createTimeConstraint(int constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum comparisonOperator, String date formula (when first char is '=') or formatted time value expr1, String date formula (when first char is '=') or formatted time value expr2) Creates a time based data validation constraint.
public String[]	getExplicitListValues() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getExplicitListValues. If validation type is `ValidationType#LIST` and `formula1` was comma-separated literal values rather than a range or named range, returns list of literal values.
public String	getFormula1() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula1.
public String	getFormula2() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula2.
private static String	Returns: all text after '=' if textExpr begins with '='. Otherwise `null` if textExpr does not begin with '=' getFormulaFromTextExpression(String a formula or value expression textExpr) Distinguishes formula expressions from simple value expressions.
public int	getOperator() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getOperator.
public int	getValidationType() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getValidationType.
public Double	Returns: the numeric value for expression 1. May be `null` getValue1()
public Double	Returns: the numeric value for expression 2. May be `null` getValue2()
public boolean	Returns: `true` if this constraint is a 'list' validation with explicit values isExplicitList() Convenience method
public boolean	Returns: `true` if this constraint is a 'list' validation isListValidationType() Convenience method
public void	setExplicitListValues(String[] explicitListValues) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setExplicitListValues.
public void	setFormula1(String formula1) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula1. Sets a formula for expression 1.
public void	setFormula2(String formula2) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula2. Sets a formula for expression 2.
public void	setOperator(int operator) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setOperator. Sets the comparison operator for this constraint
public void	setValue1(double value1) Sets a numeric value for expression 1.
public void	setValue2(double value2) Sets a numeric value for expression 2.
private static DVConstraint.FormulaValuePair	toFormulaString(Ptg[] ptgs, FormulaRenderingWorkbook book)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_explicitListValues	back to summary
private String[] _explicitListValues

_formula1	back to summary
private String _formula1

_formula2	back to summary
private String _formula2

_operator	back to summary
private int _operator

_validationType	back to summary
private final int _validationType

_value1	back to summary
private Double _value1

_value2	back to summary
private Double _value2

DVConstraint	back to summary
private DVConstraint(int validationType, int comparisonOperator, String formulaA, String formulaB, Double value1, Double value2, String[] explicitListValues)

DVConstraint	back to summary
private DVConstraint(String listFormula, String[] explicitListValues) Creates a list constraint

Method Detail

convertDate	back to summary
private static Double convertDate(String dateStr, SimpleDateFormat dateFormat) Parameters dateFormat:SimpleDateFormat pass `null` for default YYYYMMDD Returns:Double `null` if timeStr is `null`

convertDoubleFormula	back to summary
private static Ptg[] convertDoubleFormula(String formula, Double value, HSSFSheet sheet) Returns:Ptg[] The parsed token array representing the formula or value specified. Empty array if both formula and value are `null` Annotations @SuppressWarnings:resource

convertNumber	back to summary
private static Double convertNumber(String numberStr) Returns:Double `null` if numberStr is `null`

convertTime	back to summary
private static Double convertTime(String timeStr) Returns:Double `null` if timeStr is `null`

createCustomFormulaConstraint	back to summary
public static DVConstraint createCustomFormulaConstraint(String formula)

createDateConstraint back to summary

createDateConstraint	back to summary
public static DVConstraint createDateConstraint(int comparisonOperator, String expr1, String expr2, 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:int constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum expr1:String date formula (when first char is '=') or formatted date value expr2:String date formula (when first char is '=') or formatted date value dateFormat:String 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

public static DVConstraint createDateConstraint(int comparisonOperator, String expr1, String expr2, 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:int: constant from org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType enum
expr1:String: date formula (when first char is '=') or formatted date value
expr2:String: date formula (when first char is '=') or formatted date value
dateFormat:String: 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

createDVConstraint	back to summary
pack-priv static DVConstraint createDVConstraint(DVRecord dvRecord, FormulaRenderingWorkbook book)

createExplicitListConstraint	back to summary
public static DVConstraint createExplicitListConstraint(String[] explicitListValues)

createFormulaListConstraint	back to summary
public static DVConstraint createFormulaListConstraint(String listFormula)

createFormulas	back to summary
pack-priv DVConstraint.FormulaPair createFormulas(HSSFSheet sheet) Returns:DVConstraint.FormulaPair both parsed formulas (for expression 1 and 2).

createListFormula	back to summary
private Ptg[] createListFormula(HSSFSheet sheet) Annotations @SuppressWarnings:resource

createNumericConstraint back to summary

createNumericConstraint	back to summary
public static DVConstraint createNumericConstraint(int validationType, int comparisonOperator, String expr1, 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:int one of `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#ANY`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#DECIMAL`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#INTEGER`, `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#TEXT_LENGTH` comparisonOperator:int any constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum expr1:String date formula (when first char is '=') or formatted number value expr2:String date formula (when first char is '=') or formatted number value

public static DVConstraint createNumericConstraint(int validationType, int comparisonOperator, String expr1, 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:int: one of org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#ANY, org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#DECIMAL, org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#INTEGER, org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType#TEXT_LENGTH
comparisonOperator:int: any constant from org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType enum
expr1:String: date formula (when first char is '=') or formatted number value
expr2:String: date formula (when first char is '=') or formatted number value

createTimeConstraint back to summary

createTimeConstraint	back to summary
public static DVConstraint createTimeConstraint(int comparisonOperator, String expr1, 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:int constant from `org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType` enum expr1:String date formula (when first char is '=') or formatted time value expr2:String date formula (when first char is '=') or formatted time value

public static DVConstraint createTimeConstraint(int comparisonOperator, String expr1, 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:int: constant from org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType enum
expr1:String: date formula (when first char is '=') or formatted time value
expr2:String: date formula (when first char is '=') or formatted time value

getExplicitListValues back to summary

getExplicitListValues	back to summary
public String[] getExplicitListValues() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getExplicitListValues. Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getExplicitListValues. If validation type is `ValidationType#LIST` and `formula1` was comma-separated literal values rather than a range or named range, returns list of literal values. Otherwise returns `null`. Annotations @Override

public String[] getExplicitListValues()

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getExplicitListValues.

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getExplicitListValues.

If validation type is ValidationType#LIST and formula1 was comma-separated literal values rather than a range or named range, returns list of literal values. Otherwise returns null.

Annotations

@Override

getFormula1 back to summary

getFormula1	back to summary
public String getFormula1() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula1. Returns:String Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula1. the formula for expression 1. May be `null` Annotations @Override

public String getFormula1()

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula1.

Returns:String

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula1.

the formula for expression 1. May be null

Annotations

@Override

getFormula2 back to summary

getFormula2	back to summary
public String getFormula2() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula2. Returns:String Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula2. the formula for expression 2. May be `null` Annotations @Override

public String getFormula2()

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula2.

Returns:String

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getFormula2.

the formula for expression 2. May be null

Annotations

@Override

getFormulaFromTextExpression back to summary

getFormulaFromTextExpression	back to summary
private static String getFormulaFromTextExpression(String textExpr) Distinguishes formula expressions from simple value expressions. This logic is only required by a few factory methods in this class that create data validation constraints from more or less the same parameters that would have been entered in the Excel UI. The data validation dialog box uses the convention that formulas begin with '='. Other methods in this class follow the POI convention (formulas and values are distinct), so the '=' convention is not used there. Parameters textExpr:String a formula or value expression Returns:String all text after '=' if textExpr begins with '='. Otherwise `null` if textExpr does not begin with '='

private static String getFormulaFromTextExpression(String textExpr)

Distinguishes formula expressions from simple value expressions. This logic is only required by a few factory methods in this class that create data validation constraints from more or less the same parameters that would have been entered in the Excel UI. The data validation dialog box uses the convention that formulas begin with '='. Other methods in this class follow the POI convention (formulas and values are distinct), so the '=' convention is not used there.

Parameters

textExpr:String: a formula or value expression

Returns:String

all text after '=' if textExpr begins with '='. Otherwise null if textExpr does not begin with '='

getOperator	back to summary
public int getOperator() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getOperator. Returns:int Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getOperator. the operator used for this constraint Annotations @Override

getOperator

back to summary

public int getOperator()

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getOperator.

Returns:int

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getOperator.

the operator used for this constraint

Annotations

@Override

getValidationType	back to summary
public int getValidationType() Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getValidationType. Returns:int Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getValidationType. data validation type of this constraint Annotations @Override

getValidationType

back to summary

public int getValidationType()

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.getValidationType.

Returns:int

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.getValidationType.

data validation type of this constraint

Annotations

@Override

getValue1	back to summary
public Double getValue1() Returns:Double the numeric value for expression 1. May be `null`

getValue2	back to summary
public Double getValue2() Returns:Double the numeric value for expression 2. May be `null`

isExplicitList back to summary

isExplicitList	back to summary
public boolean isExplicitList() Convenience method Returns:boolean `true` if this constraint is a 'list' validation with explicit values

public boolean isExplicitList()

Convenience method

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

isListValidationType back to summary

isListValidationType	back to summary
public boolean isListValidationType() Convenience method Returns:boolean `true` if this constraint is a 'list' validation

public boolean isListValidationType()

Convenience method

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

setExplicitListValues	back to summary
public void setExplicitListValues(String[] explicitListValues) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setExplicitListValues. Annotations @Override

setExplicitListValues

back to summary

public void setExplicitListValues(String[] explicitListValues)

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setExplicitListValues.

Annotations

@Override

setFormula1	back to summary
public void setFormula1(String formula1) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula1. Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula1. Sets a formula for expression 1. Annotations @Override

setFormula1

back to summary

public void setFormula1(String formula1)

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula1.

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula1.

Sets a formula for expression 1.

Annotations

@Override

setFormula2	back to summary
public void setFormula2(String formula2) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula2. Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula2. Sets a formula for expression 2. Annotations @Override

setFormula2

back to summary

public void setFormula2(String formula2)

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula2.

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setFormula2.

Sets a formula for expression 2.

Annotations

@Override

setOperator	back to summary
public void setOperator(int operator) Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setOperator. Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setOperator. Sets the comparison operator for this constraint Annotations @Override

setOperator

back to summary

public void setOperator(int operator)

Implements org.apache.poi.ss.usermodel.DataValidationConstraint.setOperator.

Doc from org.apache.poi.ss.usermodel.DataValidationConstraint.setOperator.

Sets the comparison operator for this constraint

Annotations

@Override

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

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

toFormulaString	back to summary
private static DVConstraint.FormulaValuePair toFormulaString(Ptg[] ptgs, FormulaRenderingWorkbook book)

public Class DVConstraint

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class DVConstraint.FormulaPair

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DVConstraint.FormulaValuePair

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public String	formula()
public String	string()
public Double	value()