Integer Class Reference

The Integer data type class represents an integer value. More...

Inheritance diagram for Integer:

Collaboration diagram for Integer:

Static Public Member Functions
_.Library.Integer	DisplayToLogical (_, _.Library.String val)
	Converts the input value val, which is a string representing an integer,. More...
_.Library.Status	IsValid (_, _.Library.RawString val)
	Tests if the logical value val, which is an integer value, is valid. More...
_.Library.String	LogicalToDisplay (_, _.Library.Integer val)
	Converts the value of val, which is in logical integer format, into a display string. More...
_.Library.Integer	Normalize (_, _.Library.RawString val)
	Converts val to a normalized value.
_.Library.Integer	XSDToLogical (_, _.Library.String val)
	Converts the SOAP encoded input decimal value into a logical value. More...

Static Public Attributes
	DISPLAYLIST = None
	The Integer data type class represents an integer value. More...
	FORMAT = None
	The format specification for the data type's display value. More...
	MAXVAL = None
	The maximum allowed logical value for the data type.
	MINVAL = None
	The minimum allowed logical value for the data type.
	STRICT = None
	If '1' then <method>IsValid</method> will return false for numbers that are not integers e.g. More...
	VALUELIST = None
	Used for enumerated (multiple-choice) attributes. More...
	XMLTotalDigits = None
	The total number of digits for XML verification as defined by http://www.w3.org/TR/xmlschema-2/#rf-totalDigits.
	XSDTYPE = None
	Declares the XSD type used when projecting XML Schemas.
Static Public Attributes inherited from DataType
	INDEXNULLMARKER = None
	Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...

Detailed Description

The Integer data type class represents an integer value.

The logical value of the Integer data type is an integer. The Integer datatype does not have built-in limits. It is a hybrid datatype the values of which is not exact outside of a certain range (currently it is the same range as that of the 64-bit integer value). The current range for xDBC projections can be seen under configuration/advanced. Its default corresponds to the usual signed 32-bit integer limits.

Member Function Documentation

DisplayToLogical()

_.Library.Integer DisplayToLogical (   _, _.Library.String  val  )

static

Converts the input value val, which is a string representing an integer,.

into a logical integer value.

Returns the logical integer value of the input string val.

Reimplemented in Boolean.

IsValid()

_.Library.Status IsValid (   _, _.Library.RawString  val  )

static

Tests if the logical value val, which is an integer value, is valid.

The validation is based on the class parameter settings used for the class attribute this data type is associated with. In this case, MAXVAL and MINVAL.

Reimplemented from DataType.

Reimplemented in TinyInt, SmallInt, Boolean, and BigInt.

LogicalToDisplay()

_.Library.String LogicalToDisplay (   _, _.Library.Integer  val  )

static

Converts the value of val, which is in logical integer format, into a display string.

The formatting is based on the value of the FORMAT parameter.

Returns the formatted value of val.

XSDToLogical()

_.Library.Integer XSDToLogical (   _, _.Library.String  val  )

static

Converts the SOAP encoded input decimal value into a logical value.

Returns "" for error.

Reimplemented in TinyInt, SmallInt, Boolean, and BigInt.

Member Data Documentation

DISPLAYLIST

DISPLAYLIST = None

static

The Integer data type class represents an integer value.

The logical value of the Integer data type is an integer. The Integer datatype does not have built-in limits. It is a hybrid datatype the values of which is not exact outside of a certain range (currently it is the same range as that of the 64-bit integer value). The current range for xDBC projections can be seen under configuration/advanced. Its default corresponds to the usual signed 32-bit integer limits.

Used for enumerated (multiple-choice) attributes.

Used in conjunction with the VALUELIST parameter for enumerated (multiple-choice) attributes. DISPLAYLIST, if not null, represents the display values for the attribute corresponding with the logical values listed in VALUELIST.

The display values are returned by the LogicalToDisplay method.

FORMAT

FORMAT = None

static

The format specification for the data type's display value.

The value of FORMAT corresponds to the formatting option of the $FNUMBER function, which is used to perform the formatting.

STRICT

STRICT = None

static

If '1' then <method>IsValid</method> will return false for numbers that are not integers e.g.

1.2, -0.01

rather than the default behavior which is to allow these an normalize them to an integer. This validation is done by $number using "I" format, so the rules associated with this function apply.

VALUELIST

VALUELIST = None

static

Used for enumerated (multiple-choice) attributes.

VALUELIST is either a null string ("") or a delimiter separated list (where the delimiter is the first character) of logical values. If a non-null value is present, then the attribute is restricted to values in the list, and the validation code simply checks to see if the value is in the list.