Module org.apache.jena.core
Class XSSimpleTypeDelegate
java.lang.Object
org.apache.jena.ext.xerces.impl.dv.xs.XSSimpleTypeDelegate
- All Implemented Interfaces:
XSSimpleType
,XSObject
,XSSimpleTypeDefinition
,XSTypeDefinition
Base class for XSSimpleType wrapper implementations.
@xerces.internal
- Version:
- $Id: XSSimpleTypeDelegate.java 1024038 2010-10-18 22:06:35Z sandygao $
-
Field Summary
Fields inherited from interface org.apache.jena.ext.xerces.impl.dv.XSSimpleType
PRIMITIVE_ANYURI, PRIMITIVE_BASE64BINARY, PRIMITIVE_BOOLEAN, PRIMITIVE_DATE, PRIMITIVE_DATETIME, PRIMITIVE_DECIMAL, PRIMITIVE_DOUBLE, PRIMITIVE_DURATION, PRIMITIVE_FLOAT, PRIMITIVE_GDAY, PRIMITIVE_GMONTH, PRIMITIVE_GMONTHDAY, PRIMITIVE_GYEAR, PRIMITIVE_GYEARMONTH, PRIMITIVE_HEXBINARY, PRIMITIVE_NOTATION, PRIMITIVE_PRECISIONDECIMAL, PRIMITIVE_QNAME, PRIMITIVE_STRING, PRIMITIVE_TIME, WS_COLLAPSE, WS_PRESERVE, WS_REPLACE
Fields inherited from interface org.apache.jena.ext.xerces.xs.XSSimpleTypeDefinition
FACET_ENUMERATION, FACET_FRACTIONDIGITS, FACET_LENGTH, FACET_MAXEXCLUSIVE, FACET_MAXINCLUSIVE, FACET_MAXLENGTH, FACET_MINEXCLUSIVE, FACET_MININCLUSIVE, FACET_MINLENGTH, FACET_NONE, FACET_PATTERN, FACET_TOTALDIGITS, FACET_WHITESPACE, ORDERED_FALSE, ORDERED_PARTIAL, ORDERED_TOTAL, VARIETY_ABSENT, VARIETY_ATOMIC, VARIETY_LIST, VARIETY_UNION
Fields inherited from interface org.apache.jena.ext.xerces.xs.XSTypeDefinition
COMPLEX_TYPE, SIMPLE_TYPE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
applyFacets
(XSFacets facets, short presentFacet, short fixedFacet, ValidationContext context) If this type is created from restriction, then some facets can be applied to the simple type.boolean
derivedFrom
(String namespace, String name, short derivationMethod) Convenience method which checks if this type is derived from the given ancestor type.boolean
derivedFromType
(XSTypeDefinition ancestorType, short derivationMethod) Convenience method which checks if this type is derived from the givenancestorType
.A sequence of [annotations] or an emptyXSObjectList
.boolean
Convenience attribute.{base type definition}: either a simple type definition or a complex type definition.boolean
Fundamental Facet: bounded.short
Returns the closest built-in type category this type represents or derived from.short
[facets]: all facets defined on this type.getFacet
(int facetType) A constraining facet object.A list of constraining facets if it exists, otherwise an emptyXSObjectList
.short
getFinal()
For complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} corresponding tofinal
set of this type orDERIVATION_NONE
.boolean
Fundamental Facet: cardinality.short
[facets]: all defined facets for this type which are fixed.If variety islist
the item type definition (an atomic or union simple type definition) is available, otherwisenull
.A list of enumeration values if it exists, otherwise an emptyStringList
.getLexicalFacetValue
(short facetName) Convenience method.A list of pattern values if it exists, otherwise an emptyStringList
.If variety isunion
the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList
.A list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList
.getName()
The name of typeNCName
, as defined in XML Namespaces, of this declaration specified in the{name}
property of the component ornull
if the definition of this component does not have a{name}
property.The [target namespace] of this object, ornull
if it is unspecified.A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornull
otherwise.boolean
Fundamental Facet: numeric.short
Fundamental Facet: ordered.short
return an ID representing the built-in primitive base type.If variety isatomic
the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull
.short
getType()
Thetype
of this object, i.e.short
Return whether this type definition is a simple type or complex type.short
[variety]: one of {atomic, list, union} or absent.short
Return the whitespace corresponding to this datatype.boolean
isDefinedFacet
(short facetName) Convenience method.boolean
Check whether two actual values are equal.boolean
isFinal
(short restriction) {final}.boolean
isFixedFacet
(short facetName) Convenience method.boolean
isIDType()
Check whether this type is or is derived from ID.toString()
validate
(Object content, ValidationContext context, ValidatedInfo validatedInfo) validate a given string value, represented by content.toString().validate
(String content, ValidationContext context, ValidatedInfo validatedInfo) validate a given string against this simple type.void
validate
(ValidationContext context, ValidatedInfo validatedInfo) Validate an actual value against this simple type.
-
Constructor Details
-
XSSimpleTypeDelegate
-
-
Method Details
-
getWrappedXSSimpleType
-
getAnnotations
Description copied from interface:XSSimpleTypeDefinition
A sequence of [annotations] or an emptyXSObjectList
.- Specified by:
getAnnotations
in interfaceXSSimpleTypeDefinition
-
getBounded
public boolean getBounded()Description copied from interface:XSSimpleTypeDefinition
Fundamental Facet: bounded.- Specified by:
getBounded
in interfaceXSSimpleTypeDefinition
-
getBuiltInKind
public short getBuiltInKind()Description copied from interface:XSSimpleTypeDefinition
Returns the closest built-in type category this type represents or derived from. For example, if this simple type is a built-in derived type integer theINTEGER_DV
is returned.- Specified by:
getBuiltInKind
in interfaceXSSimpleTypeDefinition
-
getDefinedFacets
public short getDefinedFacets()Description copied from interface:XSSimpleTypeDefinition
[facets]: all facets defined on this type. The value is a bit combination of FACET_XXX constants of all defined facets.- Specified by:
getDefinedFacets
in interfaceXSSimpleTypeDefinition
-
getFacets
Description copied from interface:XSSimpleTypeDefinition
A list of constraining facets if it exists, otherwise an emptyXSObjectList
. Note: This method must not be used to retrieve values forenumeration
andpattern
facets.- Specified by:
getFacets
in interfaceXSSimpleTypeDefinition
-
getFacet
Description copied from interface:XSSimpleTypeDefinition
A constraining facet object. An instance of XSFacet or XSMultiValueFacet.- Specified by:
getFacet
in interfaceXSSimpleTypeDefinition
-
getFinite
public boolean getFinite()Description copied from interface:XSSimpleTypeDefinition
Fundamental Facet: cardinality.- Specified by:
getFinite
in interfaceXSSimpleTypeDefinition
-
getFixedFacets
public short getFixedFacets()Description copied from interface:XSSimpleTypeDefinition
[facets]: all defined facets for this type which are fixed.- Specified by:
getFixedFacets
in interfaceXSSimpleTypeDefinition
-
getItemType
Description copied from interface:XSSimpleTypeDefinition
If variety islist
the item type definition (an atomic or union simple type definition) is available, otherwisenull
.- Specified by:
getItemType
in interfaceXSSimpleTypeDefinition
-
getLexicalEnumeration
Description copied from interface:XSSimpleTypeDefinition
A list of enumeration values if it exists, otherwise an emptyStringList
.- Specified by:
getLexicalEnumeration
in interfaceXSSimpleTypeDefinition
-
getLexicalFacetValue
Description copied from interface:XSSimpleTypeDefinition
Convenience method. Returns a value of a single constraining facet for this simple type definition. This method must not be used to retrieve values forenumeration
andpattern
facets.- Specified by:
getLexicalFacetValue
in interfaceXSSimpleTypeDefinition
- Parameters:
facetName
- The name of the facet, i.e.FACET_LENGTH, FACET_TOTALDIGITS
. To retrieve the value for a pattern or an enumeration, seeenumeration
andpattern
.- Returns:
- A value of the facet specified in
facetName
for this simple type definition ornull
.
-
getLexicalPattern
Description copied from interface:XSSimpleTypeDefinition
A list of pattern values if it exists, otherwise an emptyStringList
.- Specified by:
getLexicalPattern
in interfaceXSSimpleTypeDefinition
-
getMemberTypes
Description copied from interface:XSSimpleTypeDefinition
If variety isunion
the list of member type definitions (a non-empty sequence of simple type definitions) is available, otherwise an emptyXSObjectList
.- Specified by:
getMemberTypes
in interfaceXSSimpleTypeDefinition
-
getMultiValueFacets
Description copied from interface:XSSimpleTypeDefinition
A list of enumeration and pattern constraining facets if it exists, otherwise an emptyXSObjectList
.- Specified by:
getMultiValueFacets
in interfaceXSSimpleTypeDefinition
-
getNumeric
public boolean getNumeric()Description copied from interface:XSSimpleTypeDefinition
Fundamental Facet: numeric.- Specified by:
getNumeric
in interfaceXSSimpleTypeDefinition
-
getOrdered
public short getOrdered()Description copied from interface:XSSimpleTypeDefinition
Fundamental Facet: ordered.- Specified by:
getOrdered
in interfaceXSSimpleTypeDefinition
-
getPrimitiveType
Description copied from interface:XSSimpleTypeDefinition
If variety isatomic
the primitive type definition (a built-in primitive datatype definition or the simple ur-type definition) is available, otherwisenull
.- Specified by:
getPrimitiveType
in interfaceXSSimpleTypeDefinition
-
getVariety
public short getVariety()Description copied from interface:XSSimpleTypeDefinition
[variety]: one of {atomic, list, union} or absent.- Specified by:
getVariety
in interfaceXSSimpleTypeDefinition
-
isDefinedFacet
public boolean isDefinedFacet(short facetName) Description copied from interface:XSSimpleTypeDefinition
Convenience method. [Facets]: check whether a facet is defined on this type.- Specified by:
isDefinedFacet
in interfaceXSSimpleTypeDefinition
- Parameters:
facetName
- The name of the facet.- Returns:
- True if the facet is defined, false otherwise.
-
isFixedFacet
public boolean isFixedFacet(short facetName) Description copied from interface:XSSimpleTypeDefinition
Convenience method. [Facets]: check whether a facet is defined and fixed on this type.- Specified by:
isFixedFacet
in interfaceXSSimpleTypeDefinition
- Parameters:
facetName
- The name of the facet.- Returns:
- True if the facet is fixed, false otherwise.
-
derivedFrom
Description copied from interface:XSTypeDefinition
Convenience method which checks if this type is derived from the given ancestor type.- Specified by:
derivedFrom
in interfaceXSTypeDefinition
- Parameters:
namespace
- An ancestor type namespace.name
- An ancestor type name.derivationMethod
- A bit combination representing a subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
}.- Returns:
- True if this type is derived from
ancestorType
using only derivation methods from thederivationMethod
.
-
derivedFromType
Description copied from interface:XSTypeDefinition
Convenience method which checks if this type is derived from the givenancestorType
.- Specified by:
derivedFromType
in interfaceXSTypeDefinition
- Parameters:
ancestorType
- An ancestor type definition.derivationMethod
- A bit combination representing a subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
}.- Returns:
- True if this type is derived from
ancestorType
using only derivation methods from thederivationMethod
.
-
getAnonymous
public boolean getAnonymous()Description copied from interface:XSTypeDefinition
Convenience attribute. A boolean that specifies if the type definition is anonymous.- Specified by:
getAnonymous
in interfaceXSTypeDefinition
-
getBaseType
Description copied from interface:XSTypeDefinition
{base type definition}: either a simple type definition or a complex type definition.- Specified by:
getBaseType
in interfaceXSTypeDefinition
-
getFinal
public short getFinal()Description copied from interface:XSTypeDefinition
For complex types the returned value is a bit combination of the subset of {DERIVATION_EXTENSION, DERIVATION_RESTRICTION
} corresponding tofinal
set of this type orDERIVATION_NONE
. For simple types the returned value is a bit combination of the subset of {DERIVATION_RESTRICTION, DERIVATION_EXTENSION, DERIVATION_UNION, DERIVATION_LIST
} corresponding tofinal
set of this type orDERIVATION_NONE
.- Specified by:
getFinal
in interfaceXSTypeDefinition
-
getTypeCategory
public short getTypeCategory()Description copied from interface:XSTypeDefinition
Return whether this type definition is a simple type or complex type.- Specified by:
getTypeCategory
in interfaceXSTypeDefinition
-
isFinal
public boolean isFinal(short restriction) Description copied from interface:XSTypeDefinition
{final}. For a complex type definition it is a subset of {extension, restriction}. For a simple type definition it is a subset of {extension, list, restriction, union}.- Specified by:
isFinal
in interfaceXSTypeDefinition
- Parameters:
restriction
- Extension, restriction, list, union constants (defined inXSConstants
).- Returns:
- True if
restriction
is in the final set, otherwise false.
-
getName
Description copied from interface:XSObject
The name of typeNCName
, as defined in XML Namespaces, of this declaration specified in the{name}
property of the component ornull
if the definition of this component does not have a{name}
property. For anonymous types, the processor must construct and expose an anonymous type name that is distinct from the name of every named type and the name of every other anonymous type. -
getNamespace
Description copied from interface:XSObject
The [target namespace] of this object, ornull
if it is unspecified.- Specified by:
getNamespace
in interfaceXSObject
-
getNamespaceItem
Description copied from interface:XSObject
A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornull
otherwise.- Specified by:
getNamespaceItem
in interfaceXSObject
-
getType
public short getType()Description copied from interface:XSObject
Thetype
of this object, i.e.ELEMENT_DECLARATION
. -
applyFacets
public void applyFacets(XSFacets facets, short presentFacet, short fixedFacet, ValidationContext context) throws InvalidDatatypeFacetException Description copied from interface:XSSimpleType
If this type is created from restriction, then some facets can be applied to the simple type.XSFacets
is used to pass the value of different facets.- Specified by:
applyFacets
in interfaceXSSimpleType
- Parameters:
facets
- the value of all the facetspresentFacet
- bit combination value of the costraining facet constants which are present.fixedFacet
- bit combination value of the costraining facet constants which are fixed.context
- the validation context- Throws:
InvalidDatatypeFacetException
- exception for invalid facet values.
-
getPrimitiveKind
public short getPrimitiveKind()Description copied from interface:XSSimpleType
return an ID representing the built-in primitive base type. REVISIT: This method is (currently) for internal use only. the constants returned from this method are not finalized yet. the names and values might change in the further.- Specified by:
getPrimitiveKind
in interfaceXSSimpleType
- Returns:
- an ID representing the built-in primitive base type
-
getWhitespace
Description copied from interface:XSSimpleType
Return the whitespace corresponding to this datatype.- Specified by:
getWhitespace
in interfaceXSSimpleType
- Returns:
- valid values are WS_PRESERVE, WS_REPLACE, WS_COLLAPSE.
- Throws:
DatatypeException
- union datatypes don't have whitespace facet associated with them
-
isEqual
Description copied from interface:XSSimpleType
Check whether two actual values are equal.- Specified by:
isEqual
in interfaceXSSimpleType
- Parameters:
value1
- the first valuevalue2
- the second value- Returns:
- true if the two value are equal
-
isIDType
public boolean isIDType()Description copied from interface:XSSimpleType
Check whether this type is or is derived from ID. REVISIT: this method makes ID special, which is not a good design. but since ID is not a primitive, there doesn't seem to be a clean way of doing it except to define special method like this.- Specified by:
isIDType
in interfaceXSSimpleType
- Returns:
- whether this simple type is or is derived from ID.
-
validate
public void validate(ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleType
Validate an actual value against this simple type.- Specified by:
validate
in interfaceXSSimpleType
- Parameters:
context
- the validation contextvalidatedInfo
- used to provide the actual value and member types- Throws:
InvalidDatatypeValueException
- exception for invalid values.
-
validate
public Object validate(String content, ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleType
validate a given string against this simple type.- Specified by:
validate
in interfaceXSSimpleType
- Parameters:
content
- the string value that needs to be validatedcontext
- the validation contextvalidatedInfo
- used to store validation result- Returns:
- the actual value (QName, Boolean) of the string value
- Throws:
InvalidDatatypeValueException
-
validate
public Object validate(Object content, ValidationContext context, ValidatedInfo validatedInfo) throws InvalidDatatypeValueException Description copied from interface:XSSimpleType
validate a given string value, represented by content.toString(). note that if content is a StringBuffer, for performance reasons, it's possible that the content of the string buffer is modified.- Specified by:
validate
in interfaceXSSimpleType
- Parameters:
content
- the string value that needs to be validatedcontext
- the validation contextvalidatedInfo
- used to store validation result- Returns:
- the actual value (QName, Boolean) of the string value
- Throws:
InvalidDatatypeValueException
-
toString
-