|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectCrystalValue
com.crystaldecisions.reports.common.value.FormulaValue
com.crystaldecisions.reports.common.value.ArrayValue
public final class ArrayValue
Provides methods for converting native Java types to a format understood by the Crystal Reports
Formula Language. All Java user defined functions must return a FormulaValue
object.
Field Summary | |
---|---|
static ArrayValue |
emptyBooleanArray
An ArrayValue that represents an empty boolean array. |
static ArrayValue |
emptyCurrencyArray
An ArrayValue that represents an empty currency array. |
static ArrayValue |
emptyCurrencyRangeArray
An ArrayValue that represents an empty currency range array. |
static ArrayValue |
emptyDateArray
An ArrayValue that represents an empty date array. |
static ArrayValue |
emptyDateRangeArray
An ArrayValue that represents an empty date range array. |
static ArrayValue |
emptyDateTimeArray
An ArrayValue that represents an empty date-time array. |
static ArrayValue |
emptyDateTimeRangeArray
An ArrayValue that represents an empty date-time range array. |
static ArrayValue |
emptyNumberArray
An ArrayValue that represents an empty number array. |
static ArrayValue |
emptyNumberRangeArray
An ArrayValue that represents an empty number range array. |
static ArrayValue |
emptyStringArray
An ArrayValue that represents an empty string array. |
static ArrayValue |
emptyStringRangeArray
An ArrayValue that represents an empty string range array. |
static ArrayValue |
emptyTimeArray
An ArrayValue that represents an empty time array. |
static ArrayValue |
emptyTimeRangeArray
An ArrayValue that represents an empty time range array. |
Method Summary | |
---|---|
FormulaValue |
coerceToArray()
Internal use only. |
FormulaValue |
coerceToBoolean()
Internal use only. |
FormulaValue |
coerceToCurrency()
Internal use only. |
FormulaValue |
coerceToDate()
Internal use only. |
FormulaValue |
coerceToDateTime()
Internal use only. |
FormulaValue |
coerceToNumber()
Internal use only. |
FormulaValue |
coerceToRange()
Internal use only. |
FormulaValue |
coerceToString()
Internal use only. |
FormulaValue |
coerceToTime()
Internal use only. |
int |
compareTo(java.lang.Object obj,
java.util.Comparator stringComparator)
Internal use only. |
boolean |
equals(java.lang.Object obj,
boolean caseInsensitive)
Determines whether the parameter Object is an ArrayValue object
with the same class and length as this object. |
static ArrayValue |
fromArray(FormulaValue[] formulaValueArray)
Returns an ArrayValue object that represents an array of
FormulaValue objects. |
static ArrayValue |
fromArray(FormulaValue[] formulaValueArray,
FormulaValueType elementValueType)
Internal use only. |
static ArrayValue |
fromList(java.util.List formulaValueList)
Returns an ArrayValue object that represents a list of
FormulaValue objects. |
static ArrayValue |
fromList(java.util.List formulaValueList,
FormulaValueType elementValueType)
Returns an ArrayValue object that represents a list of
FormulaValue objects. |
static ArrayValue |
fromMixedRangeArray(FormulaValue[] formulaValueArray)
Returns an ArrayValue object that represents an array of FormulaValues. |
static ArrayValue |
fromMixedRangeArray(FormulaValue[] formulaValueArray,
FormulaValueType elementValueType)
Returns an ArrayValue object that represents an array of FormulaValues. |
static ArrayValue |
fromMixedRangeList(java.util.List formulaValueList)
Returns an ArrayValue object that represents a list of
FormulaValue objects. |
static ArrayValue |
fromMixedRangeList(java.util.List formulaValueList,
FormulaValueType elementValueType)
Returns an ArrayValue object that represents a list of
FormulaValue objects. |
static ArrayValue |
fromSingleValue(FormulaValue formulaValue)
Returns an ArrayValue object that represents a single
FormulaValue . |
static ArrayValue |
fromSingleValue(FormulaValue formulaValue,
FormulaValueType elementValueType)
Returns an ArrayValue object that represents a single
FormulaValue . |
FormulaValue |
get(int index)
Gets the FormulaValue object at the specified index. |
FormulaValue[] |
getArray()
Gets an array of FormulaValue objects from this ArrayValue . |
FormulaValueType |
getElementFormulaValueType()
Gets the FormulaValueType of the elements of this ArrayValue . |
int |
getEncodedSize(ValueType type)
|
int |
getEncodedSizeForArchive(ValueType type)
|
int |
getLength()
Gets the number of elements in this ArrayValue . |
java.util.List<FormulaValue> |
getList()
Gets a list of FormulaValue objects from this ArrayValue . |
ValueType |
getValueType()
Gets the ValueType of this ArrayValue object. |
int |
hashCode(boolean caseInsensitive)
Returns a hash code for this ArrayValue object. |
static ArrayValue |
Load(ValueType type,
ExtendedDataInput in)
|
static ArrayValue |
LoadFromArchive(ValueType type,
IInputArchive ar)
|
void |
store(ValueType type,
ExtendedDataOutput out)
|
void |
storeToArchive(ValueType type,
IOutputArchive ar)
|
java.lang.String |
toString()
Gets a String representation of this ArrayValue . |
Methods inherited from class com.crystaldecisions.reports.common.value.FormulaValue |
---|
coerce, coerceToArray, coerceToBoolean, coerceToCurrency, coerceToDate, coerceToDateTime, coerceToNumber, coerceToRange, coerceToRangeArray, coerceToRangeArray, coerceToString, coerceToTime, getFormulaValueType, makeZeroValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ArrayValue emptyNumberArray
An ArrayValue
that represents an empty number array.
public static final ArrayValue emptyCurrencyArray
An ArrayValue
that represents an empty currency array.
public static final ArrayValue emptyBooleanArray
An ArrayValue
that represents an empty boolean array.
public static final ArrayValue emptyDateArray
An ArrayValue
that represents an empty date array.
public static final ArrayValue emptyTimeArray
An ArrayValue
that represents an empty time array.
public static final ArrayValue emptyDateTimeArray
An ArrayValue
that represents an empty date-time array.
public static final ArrayValue emptyStringArray
An ArrayValue
that represents an empty string array.
public static final ArrayValue emptyNumberRangeArray
An ArrayValue
that represents an empty number range array.
public static final ArrayValue emptyCurrencyRangeArray
An ArrayValue
that represents an empty currency range array.
public static final ArrayValue emptyDateRangeArray
An ArrayValue
that represents an empty date range array.
public static final ArrayValue emptyTimeRangeArray
An ArrayValue
that represents an empty time range array.
public static final ArrayValue emptyDateTimeRangeArray
An ArrayValue
that represents an empty date-time range array.
public static final ArrayValue emptyStringRangeArray
An ArrayValue
that represents an empty string range array.
Method Detail |
---|
public static ArrayValue fromArray(FormulaValue[] formulaValueArray)
Returns an ArrayValue
object that represents an array of
FormulaValue
objects.
formulaValueArray
- an array of FormulaValue
objects
ArrayValue
object that represents the given
FormulaValue
array
java.lang.IllegalArgumentException
- if formulaValueArray does not contain all FormulaValues of
the same class.public static ArrayValue fromArray(FormulaValue[] formulaValueArray, FormulaValueType elementValueType)
Internal use only.
formulaValueArray
- elementValueType
-
public static ArrayValue fromMixedRangeArray(FormulaValue[] formulaValueArray)
Returns an ArrayValue
object that represents an array of FormulaValues. The
input array may contain range values and non-Range Values. Any non-Range values will be
coerced into RangeValues when the ArrayValue
is constructed.
formulaValueArray
- an array of FormulaValues
ArrayValue
object containing the specified values or null if the
provided array is null.public static ArrayValue fromMixedRangeArray(FormulaValue[] formulaValueArray, FormulaValueType elementValueType)
Returns an ArrayValue
object that represents an array of FormulaValues. The
input array may contain range values and non-Range Values. Any non-Range values will be
coerced into RangeValues when the ArrayValue
is constructed.
formulaValueArray
- an array of FormulaValueselementValueType
- the FormulaValueType of each element
ArrayValue
object containing the specified values or null if the
provided array is null.public static ArrayValue fromSingleValue(FormulaValue formulaValue)
Returns an ArrayValue
object that represents a single
FormulaValue
.
formulaValue
- the FormulaValue
value
ArrayValue
that represents the given FormulaValue
public static ArrayValue fromSingleValue(FormulaValue formulaValue, FormulaValueType elementValueType)
Returns an ArrayValue
object that represents a single
FormulaValue
.
formulaValue
- the FormulaValue
valueelementValueType
- the FormulaValueType of the element
ArrayValue
that represents the given FormulaValue
public static ArrayValue fromList(java.util.List formulaValueList)
Returns an ArrayValue
object that represents a list of
FormulaValue
objects.
formulaValueList
- the list of FormulaValue
objects
ArrayValue
that represents the given list of
FormulaValue
objectspublic static ArrayValue fromList(java.util.List formulaValueList, FormulaValueType elementValueType)
Returns an ArrayValue
object that represents a list of
FormulaValue
objects.
formulaValueList
- the list of FormulaValue
objectselementValueType
- the FormulaValueType of each element
ArrayValue
that represents the given list of
FormulaValue
objectspublic static ArrayValue fromMixedRangeList(java.util.List formulaValueList)
Returns an ArrayValue
object that represents a list of
FormulaValue
objects. The list may contain RangeValues and non-Range Values.
Any non-Range values will be coerced into RangeValues when the ArrayValue
is
constructed.
formulaValueList
- the list of FormulaValues to convert
ArrayValue
object containing the specified values or null if the
provided list is nullpublic static ArrayValue fromMixedRangeList(java.util.List formulaValueList, FormulaValueType elementValueType)
Returns an ArrayValue
object that represents a list of
FormulaValue
objects. The list may contain RangeValues and non-Range Values.
Any non-Range values will be coerced into RangeValues when the ArrayValue
is
constructed.
formulaValueList
- the list of FormulaValues to convertelementValueType
- the FormulaValueType of each element
ArrayValue
object containing the specified values or null if the
provided list is nullpublic void store(ValueType type, ExtendedDataOutput out) throws java.io.IOException
java.io.IOException
public void storeToArchive(ValueType type, IOutputArchive ar) throws ArchiveException
ArchiveException
public static ArrayValue LoadFromArchive(ValueType type, IInputArchive ar) throws ArchiveException
ArchiveException
public static ArrayValue Load(ValueType type, ExtendedDataInput in) throws java.io.IOException
java.io.IOException
public int getEncodedSizeForArchive(ValueType type)
public int getEncodedSize(ValueType type)
public FormulaValue coerceToNumber()
Internal use only.
coerceToNumber
in class FormulaValue
public FormulaValue coerceToCurrency()
Internal use only.
coerceToCurrency
in class FormulaValue
public FormulaValue coerceToBoolean()
Internal use only.
coerceToBoolean
in class FormulaValue
public FormulaValue coerceToDate()
Internal use only.
coerceToDate
in class FormulaValue
public FormulaValue coerceToTime()
Internal use only.
coerceToTime
in class FormulaValue
public FormulaValue coerceToDateTime()
Internal use only.
coerceToDateTime
in class FormulaValue
public FormulaValue coerceToString()
Internal use only.
coerceToString
in class FormulaValue
public FormulaValue coerceToRange()
Internal use only.
coerceToRange
in class FormulaValue
public FormulaValue coerceToArray()
Internal use only.
coerceToArray
in class FormulaValue
public FormulaValue[] getArray()
Gets an array of FormulaValue
objects from this ArrayValue
.
FormulaValue
objectpublic java.util.List<FormulaValue> getList()
Gets a list of FormulaValue
objects from this ArrayValue
.
List
of FormulaValue
objectspublic int getLength()
Gets the number of elements in this ArrayValue
.
ArrayValue
public FormulaValue get(int index)
Gets the FormulaValue
object at the specified index.
index
- the position from which to retrieve the FormulaValue
object
FormulaValue
object at the specified indexpublic ValueType getValueType()
Gets the ValueType
of this ArrayValue
object.
ValueType
of this ArrayValue
objectpublic FormulaValueType getElementFormulaValueType()
Gets the FormulaValueType
of the elements of this ArrayValue
.
FormulaValueType
of the elements of this ArrayValue
public boolean equals(java.lang.Object obj, boolean caseInsensitive)
Determines whether the parameter Object
is an ArrayValue
object
with the same class and length as this object.
obj
- the Object
to compare this ArrayValue
object to
true
if obj
is an instance of ArrayValue
with the same class and length as this object, and if each element of
obj
is equal to the corresponding element of this objectpublic int compareTo(java.lang.Object obj, java.util.Comparator stringComparator)
Internal use only.
public int hashCode(boolean caseInsensitive)
Returns a hash code for this ArrayValue
object.
public java.lang.String toString()
Gets a String representation of this ArrayValue
. The string is of the form:
"a([s0] [s1] [s2])" where [sN] is the String representation for element N.
ArrayValue
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |