Package com.inet.report
Class DefaultValue
- java.lang.Object
-
- com.inet.report.DefaultValue
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable
public class DefaultValue extends java.lang.Object implements java.io.Serializable, java.lang.CloneableHolder for aPromptField's default value and its description. If the default value does not have a description,getDescription()will return null. The default value's "value" may be null.- Since:
- 7.6
- See Also:
PromptField, Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description DefaultValue(java.lang.Object value, java.lang.String description)Creates a default value with field value type set as UNKNOWNDefaultValue(java.lang.Object value, java.lang.String description, int type)Creates a DefaultValue with the given value and description.protectedDefaultValue(java.lang.String description, int type)internal constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Objectclone()static DefaultValuecreateBinaryDefaultValue(java.lang.String value, java.lang.String description)Creates and returns a default value of value type Field.BINARY.static DefaultValuecreateDefaultValueFromFormula(java.lang.String value, java.lang.String description, int valueType, Engine engine)Creates and returns a default value by parsing the given value string as a CC formula.static DefaultValuecreateDefaultValueFromFormula(java.lang.String value, java.lang.String description, Engine engine)Creates and returns a default value by parsing the given value string as a CC formula.static com.inet.report.FormulaDefaultValuecreateFormulaFieldDefaultValueFromFormula(FormulaField formulaField, java.lang.String description, int valueType, Engine engine)creates and returns a default value based on the formula given.booleanequals(java.lang.Object obj)java.lang.StringgetDescription()Returns the description of this default value.intgetType()Returns the value type set in the constructor for this default valuejava.lang.ObjectgetValue()Returns the value of this default value.inthashCode()voidsetDescription(java.lang.String description)Sets the description of this default value.voidsetValue(java.lang.Object value)Sets the value of this default value.
-
-
-
Constructor Detail
-
DefaultValue
protected DefaultValue(java.lang.String description, int type)internal constructor- Parameters:
description- description of default valuetype- value type of default value- Since:
- 11.0
-
DefaultValue
public DefaultValue(java.lang.Object value, java.lang.String description, int type)Creates a DefaultValue with the given value and description. The object must be of a certain type, depending on the value type of the Prompt Field:NUMBER:java.lang.DoubleCURRENCY:java.lang.DoubleBOOLEAN:java.lang.BooleanDATE:java.sql.DateTIME:java.sql.TimeDATETIME:java.sql.TimestampSTRING:java.lang.StringRange:com.inet.report.FormulaRange
- Parameters:
value- Value of the default valuedescription- Description of the default value, can be null if there is no descriptiontype- field type of the prompt field to which this default value belongs- Throws:
java.lang.IllegalArgumentException- if the field type does not match the object type or if the field type is unknown- Since:
- 7.6
- See Also:
Field.NUMBER,Field.STRING,Field.DATETIME,Field.DATE,Field.BOOLEAN,Field.CURRENCY,Field.BINARY,Field.TIME
-
DefaultValue
public DefaultValue(java.lang.Object value, java.lang.String description)Creates a default value with field value type set as UNKNOWN- Parameters:
value- value of the default valuedescription- description of the default value, may be null- Since:
- 7.6
- See Also:
DefaultValue(Object, String, int)
-
-
Method Detail
-
createDefaultValueFromFormula
public static DefaultValue createDefaultValueFromFormula(java.lang.String value, java.lang.String description, Engine engine) throws ReportException
Creates and returns a default value by parsing the given value string as a CC formula.- Parameters:
value- value as formula syntaxdescription- description of the default value, can be nullengine- engine used to parse the formula- Returns:
- created default value
- Throws:
ReportException- if an error occurs while parsing the formula- Since:
- 7.6
-
createDefaultValueFromFormula
public static DefaultValue createDefaultValueFromFormula(java.lang.String value, java.lang.String description, int valueType, Engine engine) throws ReportException
Creates and returns a default value by parsing the given value string as a CC formula. Checks to make sure the formula's value type is the same as the value type given.- Parameters:
value- value as formula syntaxdescription- description of the default value, can be nullvalueType- value type of the default value to be created.engine- engine used to parse the formula- Returns:
- created default value
- Throws:
ReportException- if an error occurs while parsing the formula- Since:
- 7.6
-
createFormulaFieldDefaultValueFromFormula
public static com.inet.report.FormulaDefaultValue createFormulaFieldDefaultValueFromFormula(FormulaField formulaField, java.lang.String description, int valueType, Engine engine)
creates and returns a default value based on the formula given. When a prompt is created with FormulaDefaultValues, the values are parsed at run-time, making it possible to have dynamically created yet "static" default values- Parameters:
formulaField- formula field to base default value ondescription- description of default valuevalueType- value type of default valueengine- engine used to parse the formula- Returns:
- created formula default value
- Since:
- 11.0
-
createBinaryDefaultValue
public static DefaultValue createBinaryDefaultValue(java.lang.String value, java.lang.String description)
Creates and returns a default value of value type Field.BINARY. The value string is parsed as a Base64 encoded byte array.- Parameters:
value- Base64-encoded byte array as stringdescription- description of the default value, can be null- Returns:
- Created default value
- Since:
- 7.6
-
getValue
public java.lang.Object getValue()
Returns the value of this default value. Can be null. The type of this value depends on the type of the prompt field.
NUMBER:java.lang.DoubleCURRENCY:java.lang.DoubleBOOLEAN:java.lang.BooleanDATE:java.sql.DateTIME:java.sql.TimeDATETIME:java.sql.TimestampSTRING:java.lang.StringRange:com.inet.report.FormulaRange
- Returns:
- Value of this default value. Can be null.
- Since:
- 7.6
- See Also:
Field.getValueType()
-
setValue
public void setValue(java.lang.Object value)
Sets the value of this default value. Can be null. The type of the object allowed to be set depends of the type of the prompt field.
NUMBER:java.lang.DoubleCURRENCY:java.lang.DoubleBOOLEAN:java.lang.BooleanDATE:java.sql.DateTIME:java.sql.TimeDATETIME:java.sql.TimestampSTRING:java.lang.StringRange:com.inet.report.FormulaRange
- Parameters:
value- value to set.- Since:
- 7.6
- See Also:
Field.setValueType(int)
-
getDescription
public java.lang.String getDescription()
Returns the description of this default value. Will be null if there is no description for this DefaultValue.- Returns:
- the description of this default value
- Since:
- 7.6
-
setDescription
public void setDescription(java.lang.String description)
Sets the description of this default value. The description can be set to null which means this default value has not description- Parameters:
description- description to set for this default value- Since:
- 7.6
-
getType
public int getType()
Returns the value type set in the constructor for this default value- Returns:
- field value type of this default value.
- Since:
- 7.6
- See Also:
DefaultValue(Object, String, int)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException- Overrides:
clonein classjava.lang.Object- Throws:
java.lang.CloneNotSupportedException
-
-