APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.xerces.internal.impl.dv

public Class ValidatedInfo

extends Object
implements XSValue
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.xerces.internal.xs.XSValue
Imports
com.sun.org.apache.xerces.internal.impl.xs.util.ShortListImpl, .XSObjectListImpl, com.sun.org.apache.xerces.internal.xs.ShortList, .XSConstants, .XSObjectList, .XSSimpleTypeDefinition, .XSValue
Class to get the information back after content is validated. This info would be filled by validate().
Author
Neeraj Bajaj, Sun Microsystems, inc.

Field Summary

Modifier and TypeField and Description
public XSSimpleType
actualType

The declared type of the value.

public Object
actualValue

The actual value from a string value (QName, Boolean, etc.) An array of Objects if the type is a list.

public short
actualValueType

The type of the actual value.

public ShortList
itemValueTypes

In the case the value is a list or a list of unions, this value indicates the type(s) of the items in the list.

public XSSimpleType
memberType

If the type is a union type, then the member type which actually validated the string value.

public XSSimpleType[]
memberTypes

If 1.

public String
normalizedValue

The normalized value of a string value

Constructor Summary

AccessConstructor and Description
public
ValidatedInfo()

Method Summary

Modifier and TypeMethod and Description
private static short

Returns:

The primitive type from which valueType was derived.
convertToPrimitiveKind(short
A value type as defined in XSConstants.
valueType)

Returns the primitive type of the given type.

public void
copyFrom(XSValue o)

public Object
getActualValue()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getActualValue.

The actual value.

public short
getActualValueType()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getActualValueType.

The actual value built-in datatype, e.g. STRING_DT, SHORT_DT.

public ShortList
getListValueTypes()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getListValueTypes.

In the case the actual value represents a list, i.e. the actualNormalizedValueType is LIST_DT, the returned array consists of one type kind which represents the itemType .

public XSSimpleTypeDefinition
getMemberTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinition.

If the declared simple type definition is a union, return the member type actually used to validate the value.

public XSObjectList
getMemberTypeDefinitions()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinitions.

If getTypeDefinition() returns a list type whose item type is a union type, then this method returns a list with the same length as the value list, for simple types that actually validated the corresponding item in the value.

public String
getNormalizedValue()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getNormalizedValue.

The schema normalized value.

public XSSimpleTypeDefinition
getTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getTypeDefinition.

The declared simple type definition used to validate this value.

public static boolean
isComparable(ValidatedInfo info1, ValidatedInfo info2)

Returns true if the two ValidatedInfo objects can be compared in the same value space.

public void
reset()

reset the state of this object

public String
stringValue()

Return a string representation of the value.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actualTypeback to summary
public XSSimpleType actualType

The declared type of the value.

actualValueback to summary
public Object actualValue

The actual value from a string value (QName, Boolean, etc.) An array of Objects if the type is a list.

actualValueTypeback to summary
public short actualValueType

The type of the actual value. It's one of the _DT constants defined in XSConstants.java. The value is used to indicate the most specific built-in type. (i.e. short instead of decimal or integer).

itemValueTypesback to summary
public ShortList itemValueTypes

In the case the value is a list or a list of unions, this value indicates the type(s) of the items in the list. For a normal list, the length of the array is 1; for list of unions, the length of the array is the same as the length of the list.

memberTypeback to summary
public XSSimpleType memberType

If the type is a union type, then the member type which actually validated the string value.

memberTypesback to summary
public XSSimpleType[] memberTypes

If 1. the type is a union type where one of the member types is a list, or if the type is a list; and 2. the item type of the list is a union type then an array of member types used to validate the values.

normalizedValueback to summary
public String normalizedValue

The normalized value of a string value

Constructor Detail

ValidatedInfoback to summary
public ValidatedInfo()

Method Detail

convertToPrimitiveKindback to summary
private static short convertToPrimitiveKind(short valueType)

Returns the primitive type of the given type.

Parameters
valueType:short

A value type as defined in XSConstants.

Returns:short

The primitive type from which valueType was derived.

copyFromback to summary
public void copyFrom(XSValue o)
getActualValueback to summary
public Object getActualValue()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getActualValue.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getActualValue.

The actual value. null if the value is in error.

getActualValueTypeback to summary
public short getActualValueType()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getActualValueType.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getActualValueType.

The actual value built-in datatype, e.g. STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returns LIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns LISTOFUNION_DT. To query the actual value of the list or list of union type definitions use itemValueTypes().

getListValueTypesback to summary
public ShortList getListValueTypes()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getListValueTypes.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getListValueTypes.

In the case the actual value represents a list, i.e. the actualNormalizedValueType is LIST_DT, the returned array consists of one type kind which represents the itemType . For example: 

 <simpleType name="listtype"> <list
itemType="positiveInteger"/> </simpleType> <element
name="list" type="listtype"/> ... <list>1 2 3</list>
The schemaNormalizedValue value is "1 2 3", the actualNormalizedValueType value is LIST_DT, and the itemValueTypes is an array of size 1 with the value POSITIVEINTEGER_DT.
If the actual value represents a list type definition whose item type is a union type definition, i.e. LISTOFUNION_DT, for each actual value in the list the array contains the corresponding memberType kind. For example: 
 <simpleType
name='union_type' memberTypes="integer string"/> <simpleType
name='listOfUnion'> <list itemType='union_type'/>
</simpleType> <element name="list" type="listOfUnion"/>
... <list>1 2 foo</list>
The schemaNormalizedValue value is "1 2 foo", the actualNormalizedValueType is LISTOFUNION_DT , and the itemValueTypes is an array of size 3 with the following values: INTEGER_DT, INTEGER_DT, STRING_DT.
getMemberTypeDefinitionback to summary
public XSSimpleTypeDefinition getMemberTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinition.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinition.

If the declared simple type definition is a union, return the member type actually used to validate the value. Otherwise null.

getMemberTypeDefinitionsback to summary
public XSObjectList getMemberTypeDefinitions()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinitions.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getMemberTypeDefinitions.

If getTypeDefinition() returns a list type whose item type is a union type, then this method returns a list with the same length as the value list, for simple types that actually validated the corresponding item in the value.

getNormalizedValueback to summary
public String getNormalizedValue()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getNormalizedValue.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getNormalizedValue.

The schema normalized value.

getTypeDefinitionback to summary
public XSSimpleTypeDefinition getTypeDefinition()

Implements com.sun.org.apache.xerces.internal.xs.XSValue.getTypeDefinition.

Doc from com.sun.org.apache.xerces.internal.xs.XSValue.getTypeDefinition.

The declared simple type definition used to validate this value. It can be a union type.

isComparableback to summary
public static boolean isComparable(ValidatedInfo info1, ValidatedInfo info2)

Returns true if the two ValidatedInfo objects can be compared in the same value space.

resetback to summary
public void reset()

reset the state of this object

stringValueback to summary
public String stringValue()

Return a string representation of the value. If there is an actual value, use toString; otherwise, use the normalized value.