public class ExternalObjectType extends java.lang.Object implements AtomicType, java.io.Serializable
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
FIXED_UP, INCOMPLETE, INVALID, UNVALIDATED, VALIDATED, VALIDATING
?????? |
---|
ExternalObjectType(java.lang.Class javaClass,
Configuration config)
Create an external object type
|
?????? | ????? |
---|---|
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.
|
java.lang.CharSequence |
applyWhitespaceNormalization(java.lang.CharSequence value)
Apply the whitespace normalization rules for this simple 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(java.lang.Object obj)
Test whether two ExternalObjectType objects represent the same type
|
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-signnificant
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.
|
java.lang.String |
getDescription()
Get a description of this type for use in error messages.
|
java.lang.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
|
java.lang.Class |
getJavaClass()
Get the Java class to which this external object type corresponds
|
SchemaType |
getKnownBaseType()
Returns the base type that this type inherits from.
|
java.lang.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.
|
int |
getRelationship(ExternalObjectType other)
Get the relationship of this external object type to another external object type
|
ItemType |
getSuperType(TypeHierarchy th)
Get the type from which this item type is derived by restriction.
|
java.lang.String |
getSystemId()
Get the URI of the schema document where the type was originally defined.
|
java.lang.String |
getTargetNamespace()
Get the target namespace of this type
|
SequenceIterator |
getTypedValue(java.lang.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()
Returns a hash code value for the object.
|
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 |
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 |
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
|
java.lang.String |
toString() |
java.lang.String |
toString(NamePool pool)
Produce a representation of this type name for use in error messages.
|
ValidationFailure |
validate(AtomicValue primValue,
java.lang.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(java.lang.CharSequence value,
NamespaceResolver nsResolver,
NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType
|
public ExternalObjectType(java.lang.Class javaClass, Configuration config)
javaClass
- the Java class to which this type correspondsconfig
- the Saxon configurationpublic java.lang.String getName()
getName
???? SchemaType
public java.lang.String getTargetNamespace()
getTargetNamespace
???? SchemaType
public boolean isExternalType()
isExternalType
???? SimpleType
public boolean isBuiltInType()
isBuiltInType
???? AtomicType
isBuiltInType
???? SimpleType
public boolean isAbstract()
isAbstract
???? AtomicType
public boolean isPrimitiveType()
isPrimitiveType
???? AtomicType
public AtomicType getCommonAtomicType()
getCommonAtomicType
???? SimpleType
public boolean isOrdered()
isOrdered
???? AtomicType
public java.lang.String getSystemId()
getSystemId
???? SchemaType
public final int getValidationStatus()
getValidationStatus
???? SchemaComponent
SchemaComponent.UNVALIDATED
, SchemaComponent.VALIDATING
,
SchemaComponent.VALIDATED
, SchemaComponent.INVALID
, SchemaComponent.INCOMPLETE
public final int getBlock()
SchemaType.DERIVATION_LIST
and SchemaType.DERIVATION_EXTENSION
getBlock
???? SchemaType
public final int getDerivationMethod()
getDerivationMethod
???? SchemaType
SchemaType.DERIVATION_RESTRICTION
public final boolean allowsDerivation(int derivation)
allowsDerivation
???? SchemaType
derivation
- the kind of derivation, for example SchemaType.DERIVATION_LIST
public int getNameCode()
getNameCode
???? SchemaType
public final boolean isComplexType()
isComplexType
???? SchemaType
public final SchemaType getBaseType()
getBaseType
???? SchemaType
java.lang.IllegalStateException
- if this type is not valid.public ItemType getPrimitiveItemType()
getPrimitiveItemType
???? ItemType
public int getPrimitiveType()
getPrimitiveType
???? ItemType
public java.lang.String toString(NamePool pool)
public AtomicType getAtomizedItemType()
getAtomizedItemType
???? ItemType
public SchemaType getKnownBaseType()
java.lang.IllegalStateException
- if this type is not valid.public boolean isSameType(SchemaType other)
isSameType
???? SchemaType
other
- the other typepublic int getRelationship(ExternalObjectType other)
other
- the other external object typeTypeHierarchy
, for example TypeHierarchy.SUBSUMES
public java.lang.String getDescription()
SchemaType
getDescription
???? SchemaType
public void checkTypeDerivationIsOK(SchemaType type, int block) throws SchemaException
checkTypeDerivationIsOK
???? SchemaType
type
- the type from which this type is derivedblock
- the derivations that are blocked by the relevant element declarationSchemaException
- if the derivation is not allowedpublic final boolean isSimpleType()
isSimpleType
???? SchemaType
public boolean isAtomicType()
isAtomicType
???? ItemType
isAtomicType
???? SchemaType
isAtomicType
???? SimpleType
public boolean isListType()
isListType
???? SimpleType
public boolean isUnionType()
isUnionType
???? SimpleType
public int getWhitespaceAction(TypeHierarchy th)
getWhitespaceAction
???? SimpleType
th
- the type hierarchy cachepublic java.lang.CharSequence applyWhitespaceNormalization(java.lang.CharSequence value) throws ValidationException
value
- the string before whitespace normalizationValidationException
public SchemaType getBuiltInBaseType()
getBuiltInBaseType
???? SimpleType
public boolean isNamespaceSensitive()
isNamespaceSensitive
???? SimpleType
public boolean isAnonymousType()
isAnonymousType
???? SchemaType
public final SequenceIterator getTypedValue(NodeInfo node)
getTypedValue
???? SchemaType
node
- the node whose typed value is requiredAtomicValue
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
???? SchemaType
node
- the node whose typed value is requiredXPathException
public SequenceIterator getTypedValue(java.lang.CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) throws ValidationException
getTypedValue
???? 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
- checks names against XML 1.0 or XML 1.1 syntax rulesAtomicValue
ValidationException
- if the supplied value is not in the lexical space of the data typepublic ValidationFailure validate(AtomicValue primValue, java.lang.CharSequence lexicalValue, NameChecker checker)
validate
???? 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
- java.lang.UnsupportedOperationException
- in the case of an external object typepublic void analyzeContentExpression(Expression expression, int kind, StaticContext env) throws XPathException
analyzeContentExpression
???? 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 evaluation contextXPathException
- 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 evaluation contextkind
- 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 typepublic java.lang.Class getJavaClass()
public boolean matchesItem(Item item, boolean allowURIPromotion, Configuration config)
ItemType
matchesItem
???? ItemType
item
- The item to be testedpublic ValidationFailure validateContent(java.lang.CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
validateContent
???? 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
- used to check names against XML 1.0 or XML 1.1 syntax rulesjava.lang.UnsupportedOperationException
- if the type is namespace-sensitive and no namespace
resolver is suppliedpublic ItemType getSuperType(TypeHierarchy th)
ItemType
In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible.
getSuperType
???? ItemType
th
- the type hierarchy cachepublic int getFingerprint()
SchemaType
getFingerprint
???? SchemaType
public java.lang.String toString()
toString
??? java.lang.Object
public java.lang.String getDisplayName()
SchemaType
getDisplayName
???? SchemaType
public int hashCode()
hashCode
??? java.lang.Object
public boolean equals(java.lang.Object obj)
equals
??? java.lang.Object
obj
- the other ExternalObjectType