public interface

ItemPSVI

org.apache.xerces.xs.ItemPSVI
Known Indirect Subclasses

Class Overview

Represents an abstract PSVI item for an element or an attribute information item.

Summary

Constants
short VALIDATION_FULL Validation status indicating that full schema validation has been performed on the item.
short VALIDATION_NONE Validation status indicating that schema validation has been performed and the item in question has specifically been skipped.
short VALIDATION_PARTIAL Validation status indicating that schema validation has been performed on the item in question under the rules of lax validation.
short VALIDITY_INVALID Validity value indicating that validation has been strictly assessed and the item in question is invalid according to the rules of schema validation.
short VALIDITY_NOTKNOWN Validity value indicating that validation has either not been performed or that a strict assessment of validity could not be performed.
short VALIDITY_VALID Validation status indicating that schema validation has been performed and the item in question is valid according to the rules of schema validation.
Public Methods
abstract Object getActualNormalizedValue()
[schema normalized value]: Binding specific actual value or null if the value is in error.
abstract short getActualNormalizedValueType()
The actual value built-in datatype, e.g.
abstract StringList getErrorCodes()
[schema error code]: a list of error codes generated from the validation attempt or an empty StringList if no errors occurred during the validation attempt.
abstract boolean getIsSchemaSpecified()
[schema specified]: if true, the value was specified in the schema.
abstract ShortList getItemValueTypes()
In the case the actual value represents a list, i.e.
abstract XSSimpleTypeDefinition getMemberTypeDefinition()
[member type definition]: if and only if that type definition is a simple type definition with {variety} union, or a complex type definition whose {content type} is a simple type definition with {variety} union, then an item isomorphic to that member of the union's {member type definitions} which actually validated the schema item's normalized value.
abstract String getSchemaDefault()
[schema default]: the canonical lexical representation of the declaration's {value constraint} value.
abstract String getSchemaNormalizedValue()
[schema normalized value]: the normalized value of this item after validation.
abstract XSTypeDefinition getTypeDefinition()
[type definition]: an item isomorphic to the type definition used to validate the schema item.
abstract short getValidationAttempted()
[validation attempted]: determines the extent to which the schema item has been validated.
abstract String getValidationContext()
The nearest ancestor element information item with a [schema information] property (or this element item itself if it has such a property).
abstract short getValidity()
[validity]: determines the validity of the schema item with respect to the validation being attempted.

Constants

public static final short VALIDATION_FULL

Validation status indicating that full schema validation has been performed on the item.

Constant Value: 2 (0x00000002)

public static final short VALIDATION_NONE

Validation status indicating that schema validation has been performed and the item in question has specifically been skipped.

Constant Value: 0 (0x00000000)

public static final short VALIDATION_PARTIAL

Validation status indicating that schema validation has been performed on the item in question under the rules of lax validation.

Constant Value: 1 (0x00000001)

public static final short VALIDITY_INVALID

Validity value indicating that validation has been strictly assessed and the item in question is invalid according to the rules of schema validation.

Constant Value: 1 (0x00000001)

public static final short VALIDITY_NOTKNOWN

Validity value indicating that validation has either not been performed or that a strict assessment of validity could not be performed.

Constant Value: 0 (0x00000000)

public static final short VALIDITY_VALID

Validation status indicating that schema validation has been performed and the item in question is valid according to the rules of schema validation.

Constant Value: 2 (0x00000002)

Public Methods

public abstract Object getActualNormalizedValue ()

[schema normalized value]: Binding specific actual value or null if the value is in error.

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract short getActualNormalizedValueType ()

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. If the actualNormalizedValue is null, this method returns UNAVAILABLE_DT .

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract StringList getErrorCodes ()

[schema error code]: a list of error codes generated from the validation attempt or an empty StringList if no errors occurred during the validation attempt.

public abstract boolean getIsSchemaSpecified ()

[schema specified]: if true, the value was specified in the schema. If false, the value comes from the infoset. For more information refer to element specified and attribute specified.

public abstract ShortList getItemValueTypes ()

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.

Throws
XSException NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public abstract XSSimpleTypeDefinition getMemberTypeDefinition ()

[member type definition]: if and only if that type definition is a simple type definition with {variety} union, or a complex type definition whose {content type} is a simple type definition with {variety} union, then an item isomorphic to that member of the union's {member type definitions} which actually validated the schema item's normalized value.

public abstract String getSchemaDefault ()

[schema default]: the canonical lexical representation of the declaration's {value constraint} value. For more information refer to element schema default and attribute schema default.

public abstract String getSchemaNormalizedValue ()

[schema normalized value]: the normalized value of this item after validation.

public abstract XSTypeDefinition getTypeDefinition ()

[type definition]: an item isomorphic to the type definition used to validate the schema item.

public abstract short getValidationAttempted ()

[validation attempted]: determines the extent to which the schema item has been validated. The value will be one of the constants: VALIDATION_NONE, VALIDATION_PARTIAL or VALIDATION_FULL.

public abstract String getValidationContext ()

The nearest ancestor element information item with a [schema information] property (or this element item itself if it has such a property). For more information refer to element validation context and attribute validation context .

public abstract short getValidity ()

[validity]: determines the validity of the schema item with respect to the validation being attempted. The value will be one of the constants: VALIDITY_NOTKNOWN, VALIDITY_INVALID or VALIDITY_VALID.