org.apache.xerces.xs

Interface ItemPSVI

Known Subinterfaces:
AttributePSVI, ElementPSVI

public interface ItemPSVI

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

Field Summary

static short
VALIDATION_FULL
Validation status indicating that full schema validation has been performed on the item.
static short
VALIDATION_NONE
Validation status indicating that schema validation has been performed and the item in question has specifically been skipped.
static short
VALIDATION_PARTIAL
Validation status indicating that schema validation has been performed on the item in question under the rules of lax validation.
static 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.
static short
VALIDITY_NOTKNOWN
Validity value indicating that validation has either not been performed or that a strict assessment of validity could not be performed.
static 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.

Method Summary

Object
getActualNormalizedValue()
[schema normalized value]: Binding specific actual value or null if the value is in error.
short
getActualNormalizedValueType()
The actual value built-in datatype, e.g.
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.
boolean
getIsSchemaSpecified()
[schema specified]: if true, the value was specified in the schema.
ShortList
getItemValueTypes()
In the case the actual value represents a list, i.e.
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.
String
getSchemaDefault()
[schema default]: the canonical lexical representation of the declaration's {value constraint} value.
String
getSchemaNormalizedValue()
[schema normalized value]: the normalized value of this item after validation.
XSTypeDefinition
getTypeDefinition()
[type definition]: an item isomorphic to the type definition used to validate the schema item.
short
getValidationAttempted()
[validation attempted]: determines the extent to which the schema item has been validated.
String
getValidationContext()
The nearest ancestor element information item with a [schema information] property (or this element item itself if it has such a property).
short
getValidity()
[validity]: determines the validity of the schema item with respect to the validation being attempted.

Field Details

VALIDATION_FULL

public static final short VALIDATION_FULL
Validation status indicating that full schema validation has been performed on the item.
Field Value:
2

VALIDATION_NONE

public static final short VALIDATION_NONE
Validation status indicating that schema validation has been performed and the item in question has specifically been skipped.
Field Value:
0

VALIDATION_PARTIAL

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.
Field Value:
1

VALIDITY_INVALID

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.
Field Value:
1

VALIDITY_NOTKNOWN

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.
Field Value:
0

VALIDITY_VALID

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.
Field Value:
2

Method Details

getActualNormalizedValue

public Object getActualNormalizedValue()
            throws XSException
[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.

getActualNormalizedValueType

public short getActualNormalizedValueType()
            throws XSException
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.

getErrorCodes

public 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.

getIsSchemaSpecified

public 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.

getItemValueTypes

public ShortList getItemValueTypes()
            throws XSException
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.

getMemberTypeDefinition

public 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.

getSchemaDefault

public 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.

getSchemaNormalizedValue

public String getSchemaNormalizedValue()
[schema normalized value]: the normalized value of this item after validation.

getTypeDefinition

public XSTypeDefinition getTypeDefinition()
[type definition]: an item isomorphic to the type definition used to validate the schema item.

getValidationAttempted

public 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.

getValidationContext

public 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 .

getValidity

public 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.

Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved.