Top Inners Methods
org.apache.poi.ss.usermodel

public Interface DataValidationConstraint

Known Direct Implementers
org.apache.poi.hssf.usermodel.DVConstraint

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DataValidationConstraint.OperatorType

Condition operator enum

public static class
DataValidationConstraint.ValidationType

ValidationType enum

Method Summary

Modifier and TypeMethod and Description
public String[]
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

Returns:

the formula for expression 1. May be null
getFormula1()

public String

Returns:

the formula for expression 2. May be null
getFormula2()

public int

Returns:

the operator used for this constraint
getOperator()

public int

Returns:

data validation type of this constraint
getValidationType()

public void
setExplicitListValues(String[] explicitListValues)

public void
setFormula1(String formula1)

Sets a formula for expression 1.

public void
setFormula2(String formula2)

Sets a formula for expression 2.

public void
setOperator(int operator)

Sets the comparison operator for this constraint

Method Detail

getExplicitListValuesback to summary
public String[] 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.

getFormula1back to summary
public String getFormula1()
Returns:String

the formula for expression 1. May be null

getFormula2back to summary
public String getFormula2()
Returns:String

the formula for expression 2. May be null

getOperatorback to summary
public int getOperator()
Returns:int

the operator used for this constraint

See Also
OperatorType
getValidationTypeback to summary
public int getValidationType()
Returns:int

data validation type of this constraint

See Also
ValidationType
setExplicitListValuesback to summary
public void setExplicitListValues(String[] explicitListValues)
setFormula1back to summary
public void setFormula1(String formula1)

Sets a formula for expression 1.

setFormula2back to summary
public void setFormula2(String formula2)

Sets a formula for expression 2.

setOperatorback to summary
public void setOperator(int operator)

Sets the comparison operator for this constraint

See Also
OperatorType
org.apache.poi.ss.usermodel back to summary

public final Class DataValidationConstraint.OperatorType

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.usermodel.DataValidationConstraint.OperatorType
Condition operator enum

Field Summary

Modifier and TypeField and Description
public static final int
BETWEEN

public static final int
EQUAL

public static final int
GREATER_OR_EQUAL

public static final int
GREATER_THAN

public static final int
IGNORED

default value to supply when the operator type is not used

public static final int
LESS_OR_EQUAL

public static final int
LESS_THAN

public static final int
NOT_BETWEEN

public static final int
NOT_EQUAL

Constructor Summary

AccessConstructor and Description
private
OperatorType()

Method Summary

Modifier and TypeMethod and Description
public static void
validateSecondArg(int comparisonOperator, String paramValue)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BETWEENback to summary
public static final int BETWEEN
EQUALback to summary
public static final int EQUAL
GREATER_OR_EQUALback to summary
public static final int GREATER_OR_EQUAL
GREATER_THANback to summary
public static final int GREATER_THAN
IGNOREDback to summary
public static final int IGNORED

default value to supply when the operator type is not used

LESS_OR_EQUALback to summary
public static final int LESS_OR_EQUAL
LESS_THANback to summary
public static final int LESS_THAN
NOT_BETWEENback to summary
public static final int NOT_BETWEEN
NOT_EQUALback to summary
public static final int NOT_EQUAL

Constructor Detail

OperatorTypeback to summary
private OperatorType()

Method Detail

validateSecondArgback to summary
public static void validateSecondArg(int comparisonOperator, String paramValue)
org.apache.poi.ss.usermodel back to summary

public final Class DataValidationConstraint.ValidationType

extends Object
Class Inheritance
  • java.lang.Object
  • org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType
ValidationType enum

Field Summary

Modifier and TypeField and Description
public static final int
ANY

'Any value' type - value not restricted

public static final int
DATE

Date type

public static final int
DECIMAL

Decimal type

public static final int
FORMULA

Formula ( 'Custom' ) type

public static final int
INTEGER

Integer ('Whole number') type

public static final int
LIST

List type ( combo box type )

public static final int
TEXT_LENGTH

String length type

public static final int
TIME

Time type

Constructor Summary

AccessConstructor and Description
private
ValidationType()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ANYback to summary
public static final int ANY

'Any value' type - value not restricted

DATEback to summary
public static final int DATE

Date type

DECIMALback to summary
public static final int DECIMAL

Decimal type

FORMULAback to summary
public static final int FORMULA

Formula ( 'Custom' ) type

INTEGERback to summary
public static final int INTEGER

Integer ('Whole number') type

LISTback to summary
public static final int LIST

List type ( combo box type )

TEXT_LENGTHback to summary
public static final int TEXT_LENGTH

String length type

TIMEback to summary
public static final int TIME

Time type

Constructor Detail

ValidationTypeback to summary
private ValidationType()