|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.type.BuiltInAtomicType
public class BuiltInAtomicType
This class represents a built-in atomic type, which may be either a primitive type (such as xs:decimal or xs:anyURI) or a derived type (such as xs:ID or xs:dayTimeDuration).
Fields inherited from interface net.sf.saxon.type.SchemaType |
---|
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION |
Fields inherited from interface net.sf.saxon.type.SchemaComponent |
---|
FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING |
Method Summary | |
---|---|
boolean |
allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property |
void |
analyzeContentExpression(Expression expression,
int kind,
StaticContext env)
Analyze an expression to see whether the expression is capable of delivering a value of this type. |
static void |
analyzeContentExpression(SimpleType simpleType,
Expression expression,
StaticContext env,
int kind)
Analyze an expression to see whether the expression is capable of delivering a value of this type. |
Value |
atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type. |
void |
checkTypeDerivationIsOK(SchemaType type,
int block)
Check that this type is validly derived from a given type |
boolean |
equals(Object obj)
Two types are equal if they have the same fingerprint. |
AtomicType |
getAtomizedItemType()
Get the item type of the atomic values that will be produced when an item of this type is atomized |
SchemaType |
getBaseType()
Returns the base type that this type inherits from. |
int |
getBlock()
Returns the value of the 'block' attribute for this type, as a bit-significant integer with fields such as SchemaType.DERIVATION_LIST and SchemaType.DERIVATION_EXTENSION |
SchemaType |
getBuiltInBaseType()
Returns the built-in base type this type is derived from. |
AtomicType |
getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to |
int |
getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent. |
String |
getDescription()
Get a description of this type for use in error messages. |
String |
getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix |
int |
getFingerprint()
Get the fingerprint of the name of this type |
SchemaType |
getKnownBaseType()
Returns the base type that this type inherits from. |
String |
getName()
Get the local name of this type |
int |
getNameCode()
Get the namecode of the name of this type. |
ItemType |
getPrimitiveItemType()
Get the primitive item type corresponding to this item type. |
int |
getPrimitiveType()
Get the primitive type corresponding to this item type. |
StructuredQName |
getQualifiedName()
Get the name of the type as a QName |
ItemType |
getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction. |
String |
getSystemId()
Get the URI of the schema document where the type was originally defined. |
String |
getTargetNamespace()
Get the target namespace of this type |
SequenceIterator |
getTypedValue(CharSequence value,
NamespaceResolver resolver,
NameChecker nameChecker)
Get the typed value corresponding to a given string value, assuming it is valid against this type |
SequenceIterator |
getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type |
int |
getValidationStatus()
Get the validation status - always valid |
int |
getWhitespaceAction(TypeHierarchy th)
Determine the whitespace normalization required for values of this type |
int |
hashCode()
The fingerprint can be used as a hashcode |
static void |
init()
Static initialization |
boolean |
isAbstract()
Determine whether the type is abstract, that is, whether it cannot have instances that are not also instances of some concrete subtype |
boolean |
isAllowedInBasicXSLT()
Determine whether this type is supported in a basic XSLT processor |
boolean |
isAnonymousType()
Test whether this is an anonymous type |
boolean |
isAtomicType()
Test whether this Simple Type is an atomic type |
boolean |
isBuiltInType()
Determine whether this is a built-in type or a user-defined type |
boolean |
isComplexType()
Test whether this SchemaType is a complex type |
boolean |
isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects |
boolean |
isListType()
Returns true if this type is derived by list, or if it is derived by restriction from a list type, or if it is a union that contains a list as one of its members |
boolean |
isNamespaceSensitive()
Test whether this simple type is namespace-sensitive, that is, whether it is derived from xs:QName or xs:NOTATION |
boolean |
isOrdered()
Determine whether the atomic type is ordered, that is, whether less-than and greater-than comparisons are permitted |
boolean |
isPrimitiveNumeric()
Determine whether the atomic type is numeric |
boolean |
isPrimitiveType()
Determine whether the atomic type is a primitive type. |
boolean |
isSameType(SchemaType other)
Test whether this is the same type as another type. |
boolean |
isSimpleType()
Returns true if this SchemaType is a SimpleType |
boolean |
isUnionType()
Return true if this type is a union type (that is, if its variety is union) |
boolean |
matchesItem(Item item,
boolean allowURIPromotion,
Configuration config)
Test whether a given item conforms to this type |
void |
setBaseTypeFingerprint(int baseFingerprint)
Set the base type of this type |
String |
toString()
|
String |
toString(NamePool pool)
Produce a representation of this type name for use in error messages. |
ValidationFailure |
validate(AtomicValue primValue,
CharSequence lexicalValue,
NameChecker checker)
Validate that a primitive atomic value is a valid instance of a type derived from the same primitive type. |
ValidationFailure |
validateContent(CharSequence value,
NamespaceResolver nsResolver,
NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static BuiltInAtomicType ANY_ATOMIC
public static BuiltInAtomicType NUMERIC
public static BuiltInAtomicType STRING
public static BuiltInAtomicType BOOLEAN
public static BuiltInAtomicType DURATION
public static BuiltInAtomicType DATE_TIME
public static BuiltInAtomicType DATE
public static BuiltInAtomicType TIME
public static BuiltInAtomicType G_YEAR_MONTH
public static BuiltInAtomicType G_MONTH
public static BuiltInAtomicType G_MONTH_DAY
public static BuiltInAtomicType G_YEAR
public static BuiltInAtomicType G_DAY
public static BuiltInAtomicType HEX_BINARY
public static BuiltInAtomicType BASE64_BINARY
public static BuiltInAtomicType ANY_URI
public static BuiltInAtomicType QNAME
public static BuiltInAtomicType NOTATION
public static BuiltInAtomicType UNTYPED_ATOMIC
public static BuiltInAtomicType DECIMAL
public static BuiltInAtomicType FLOAT
public static BuiltInAtomicType DOUBLE
public static BuiltInAtomicType INTEGER
public static BuiltInAtomicType NON_POSITIVE_INTEGER
public static BuiltInAtomicType NEGATIVE_INTEGER
public static BuiltInAtomicType LONG
public static BuiltInAtomicType INT
public static BuiltInAtomicType SHORT
public static BuiltInAtomicType BYTE
public static BuiltInAtomicType NON_NEGATIVE_INTEGER
public static BuiltInAtomicType POSITIVE_INTEGER
public static BuiltInAtomicType UNSIGNED_LONG
public static BuiltInAtomicType UNSIGNED_INT
public static BuiltInAtomicType UNSIGNED_SHORT
public static BuiltInAtomicType UNSIGNED_BYTE
public static BuiltInAtomicType YEAR_MONTH_DURATION
public static BuiltInAtomicType DAY_TIME_DURATION
public static BuiltInAtomicType NORMALIZED_STRING
public static BuiltInAtomicType TOKEN
public static BuiltInAtomicType LANGUAGE
public static BuiltInAtomicType NAME
public static BuiltInAtomicType NMTOKEN
public static BuiltInAtomicType NCNAME
public static BuiltInAtomicType ID
public static BuiltInAtomicType IDREF
public static BuiltInAtomicType ENTITY
Method Detail |
---|
public static void init()
public String getName()
getName
in interface SchemaType
public String getTargetNamespace()
getTargetNamespace
in interface SchemaType
public boolean isAbstract()
isAbstract
in interface AtomicType
public boolean isExternalType()
isExternalType
in interface SimpleType
public boolean isBuiltInType()
isBuiltInType
in interface AtomicType
isBuiltInType
in interface SimpleType
public boolean isOrdered()
isOrdered
in interface AtomicType
public String getSystemId()
getSystemId
in interface SchemaType
public boolean isPrimitiveNumeric()
public AtomicType getCommonAtomicType()
getCommonAtomicType
in interface SimpleType
public final int getValidationStatus()
getValidationStatus
in interface SchemaComponent
SchemaComponent.UNVALIDATED
, SchemaComponent.VALIDATING
,
SchemaComponent.VALIDATED
, SchemaComponent.INVALID
, SchemaComponent.INCOMPLETE
public final int getBlock()
SchemaType.DERIVATION_LIST
and SchemaType.DERIVATION_EXTENSION
getBlock
in interface SchemaType
public final int getDerivationMethod()
getDerivationMethod
in interface SchemaType
SchemaType.DERIVATION_RESTRICTION
public final boolean allowsDerivation(int derivation)
allowsDerivation
in interface SchemaType
derivation
- the kind of derivation, for example SchemaType.DERIVATION_LIST
public final void setBaseTypeFingerprint(int baseFingerprint)
baseFingerprint
- the namepool fingerprint of the name of the base typepublic int getFingerprint()
getFingerprint
in interface SchemaType
public int getNameCode()
getNameCode
in interface SchemaType
public StructuredQName getQualifiedName()
public String getDisplayName()
getDisplayName
in interface SchemaType
public boolean isPrimitiveType()
isPrimitiveType
in interface AtomicType
public final boolean isComplexType()
isComplexType
in interface SchemaType
public boolean isAnonymousType()
isAnonymousType
in interface SchemaType
public final SchemaType getBaseType()
getBaseType
in interface SchemaType
IllegalStateException
- if this type is not valid.public boolean matchesItem(Item item, boolean allowURIPromotion, Configuration config)
matchesItem
in interface ItemType
item
- The item to be testedallowURIPromotion
- true if we regard a URI as effectively a subtype of Stringconfig
- the Saxon configuration (used to locate the type hierarchy cache)
public ItemType getSuperType(TypeHierarchy th)
getSuperType
in interface ItemType
th
- the type hierarchy cache, not used in this implementation
public ItemType getPrimitiveItemType()
getPrimitiveItemType
in interface ItemType
public int getPrimitiveType()
getPrimitiveType
in interface ItemType
public boolean isAllowedInBasicXSLT()
public String toString(NamePool pool)
toString
in interface ItemType
public AtomicType getAtomizedItemType()
getAtomizedItemType
in interface ItemType
public SchemaType getKnownBaseType()
IllegalStateException
- if this type is not valid.public boolean isSameType(SchemaType other)
isSameType
in interface SchemaType
other
- the other type
public String getDescription()
SchemaType
getDescription
in interface SchemaType
public String toString()
toString
in class Object
public void checkTypeDerivationIsOK(SchemaType type, int block) throws SchemaException
checkTypeDerivationIsOK
in interface SchemaType
type
- the type from which this type is derivedblock
- the derivations that are blocked by the relevant element declaration
SchemaException
- if the derivation is not allowedpublic final boolean isSimpleType()
isSimpleType
in interface SchemaType
public boolean isAtomicType()
isAtomicType
in interface ItemType
isAtomicType
in interface SchemaType
isAtomicType
in interface SimpleType
public boolean isListType()
isListType
in interface SimpleType
public boolean isUnionType()
isUnionType
in interface SimpleType
public int getWhitespaceAction(TypeHierarchy th)
getWhitespaceAction
in interface SimpleType
th
- the type hierarchy cache
public SchemaType getBuiltInBaseType()
getBuiltInBaseType
in interface SimpleType
public boolean isNamespaceSensitive()
isNamespaceSensitive
in interface SimpleType
public ValidationFailure validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
validateContent
in interface SimpleType
value
- the input string to be checkednsResolver
- a namespace resolver used to resolve namespace prefixes if the type
is namespace sensitive. The value supplied may be null; in this case any namespace-sensitive
content will throw an UnsupportedOperationException.nameChecker
- XML 1.0 or 1.1 name checker. Must not be null.
UnsupportedOperationException
- if the type is namespace-sensitive and no namespace
resolver is suppliedpublic final SequenceIterator getTypedValue(NodeInfo node) throws XPathException
getTypedValue
in interface SchemaType
node
- the node whose typed value is required
AtomicValue
XPathException
public Value atomize(NodeInfo node) throws XPathException
getTypedValue(net.sf.saxon.om.NodeInfo)
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.
atomize
in interface SchemaType
node
- the node whose typed value is required
XPathException
public SequenceIterator getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) throws ValidationException
getTypedValue
in interface SimpleType
value
- the string valueresolver
- a namespace resolver used to resolve any namespace prefixes appearing
in the content of values. Can supply null, in which case any namespace-sensitive content
will be rejected.nameChecker
- XML 1.0 or 1.1 name checker. May be null if name checking is not required
AtomicValue
ValidationException
- if the supplied value is not in the lexical space of the data typepublic boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public ValidationFailure validate(AtomicValue primValue, CharSequence lexicalValue, NameChecker checker)
validate
in interface AtomicType
primValue
- the value in the value space of the primitive type.lexicalValue
- the value in the lexical space. If null, the string value of primValue
is used. This value is checked against the pattern facet (if any)checker
- Used to check names against XML 1.0 or XML 1.1 syntax rules
UnsupportedOperationException
- in the case of an external object typepublic void analyzeContentExpression(Expression expression, int kind, StaticContext env) throws XPathException
analyzeContentExpression
in interface SchemaType
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered: Type.ELEMENT
,
Type.ATTRIBUTE
, or Type.DOCUMENT
env
- the static context
XPathException
- if the expression will never deliver a value of the correct typepublic static void analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind) throws XPathException
simpleType
- the simple type against which the expression is to be checkedexpression
- the expression that delivers the contentenv
- the static context of the expressionkind
- the node kind whose content is being delivered: Type.ELEMENT
,
Type.ATTRIBUTE
, or Type.DOCUMENT
XPathException
- if the expression will never deliver a value of the correct type
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |