| java.lang.Object
 net.sf.saxon.type.ExternalObjectType
| ExternalObjectType | | public class ExternalObjectType implements AtomicType,Serializable(Code) | | This class represents the type of an external Java object returned by
an extension function, or supplied as an external variable/parameter.
|
| Method Summary | |
| final public boolean | allowsDerivation(int derivation)
| | public 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. | | public 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. | | public CharSequence | applyWhitespaceNormalization(CharSequence value)
| | public Value | atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type. | | public AtomicType | getAtomizedItemType()
| | final public SchemaType | getBaseType()
Returns the base type that this type inherits from. | | final public int | getBlock()
| | public SchemaType | getBuiltInBaseType()
Returns the built-in base type this type is derived from. | | public AtomicType | getCommonAtomicType()
| | final public int | getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its
parent. | | public String | getDescription()
| | public String | getDisplayName()
| | public int | getFingerprint()
| | public Class | getJavaClass()
| | public SchemaType | getKnownBaseType()
Returns the base type that this type inherits from. | | public int | getNameCode()
Get the namecode of the name of this type. | | public ItemType | getPrimitiveItemType()
Get the primitive item type corresponding to this item type. | | public int | getPrimitiveType()
Get the primitive type corresponding to this item type. | | public ItemType | getSuperType(TypeHierarchy th)
| | final public SequenceIterator | getTypedValue(NodeInfo node)
Get the typed value of a node that is annotated with this schema type
Parameters:
node - the node whose typed value is required an iterator over the items making up the typed value of this node. | | public 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
Parameters:
value - the string value
Parameters:
resolver - a namespace resolver used to resolve any namespace prefixes appearingin the content of values. | | final public int | getValidationStatus()
| | public int | getWhitespaceAction(TypeHierarchy th)
| | public boolean | isAtomicType()
| | public boolean | isBuiltIn()
| | final public boolean | isComplexType()
| | public boolean | isListType()
| | public boolean | isNamespaceSensitive()
| | public boolean | isSameType(SchemaType other)
Test whether this is the same type as another type. | | final public boolean | isSimpleType()
| | public void | isTypeDerivationOK(SchemaType type, int block)
| | public boolean | isUnionType()
| | public AtomicValue | makeDerivedValue(AtomicValue primValue, CharSequence lexicalValue, boolean validate)
Factory method to create values of a derived atomic type. | | public boolean | matchesItem(Item item, XPathContext context)
| | public String | toString(NamePool pool)
Produce a representation of this type name for use in error messages. | | public String | toString()
| | public ValidationException | validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType
Parameters:
value - the input string to be checked
Parameters:
nsResolver - a namespace resolver used to resolve namespace prefixes if the typeis namespace sensitive. |
| baseFingerprint | | int baseFingerprint(Code) | | |
| fingerprint | | int fingerprint(Code) | | |
| ExternalObjectType | | public ExternalObjectType(Class javaClass)(Code) | | |
| allowsDerivation | | final public boolean allowsDerivation(int derivation)(Code) | | Determines whether derivation (of a particular kind)
from this type is allowed, based on the "final" property
Parameters:
derivation - the kind of derivation, for example SchemaType.DERIVATION_LIST true if this kind of derivation is allowed |
| analyzeContentExpression | | public static void analyzeContentExpression(SimpleType simpleType, Expression expression, StaticContext env, int kind) throws XPathException(Code) | | Analyze an expression to see whether the expression is capable of delivering a value of this
type.
Parameters:
simpleType - the simple type against which the expression is to be checked
Parameters:
expression - the expression that delivers the content
Parameters:
kind - the node kind whose content is being delivered: Type.ELEMENT,Type.ATTRIBUTE, or Type.DOCUMENT
throws:
net.sf.saxon.trans.XPathException - if the expression will never deliver a value of the correct type |
| applyWhitespaceNormalization | | public CharSequence applyWhitespaceNormalization(CharSequence value) throws ValidationException(Code) | | Apply the whitespace normalization rules for this simple type
Parameters:
value - the string before whitespace normalization the string after whitespace normalization |
| atomize | | public Value atomize(NodeInfo node) throws XPathException(Code) | | Get the typed value of a node that is annotated with this schema type. The result of this method will always be consistent with the method
ExternalObjectType.getTypedValue . 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.
Parameters:
node - the node whose typed value is required the typed value.
since:
8.5 |
| getAtomizedItemType | | public AtomicType getAtomizedItemType()(Code) | | Get the item type of the atomic values that will be produced when an item
of this type is atomized
|
| getBaseType | | final public SchemaType getBaseType()(Code) | | Returns the base type that this type inherits from. This method can be used to get the
base type of a type that is known to be valid.
If this type is a Simpletype that is a built in primitive type then null is returned.
the base type.
throws:
IllegalStateException - if this type is not valid. |
| getBuiltInBaseType | | public SchemaType getBuiltInBaseType() throws ValidationException(Code) | | Returns the built-in base type this type is derived from.
the first built-in type found when searching up the type hierarchy |
| getCommonAtomicType | | public AtomicType getCommonAtomicType()(Code) | | Get the most specific possible atomic type that all items in this SimpleType belong to
the lowest common supertype of all member types |
| getDerivationMethod | | final public int getDerivationMethod()(Code) | | Gets the integer code of the derivation method used to derive this type from its
parent. Returns zero for primitive types.
a numeric code representing the derivation method, for example SchemaType.DERIVATION_RESTRICTION |
| getFingerprint | | public int getFingerprint()(Code) | | |
| getKnownBaseType | | public SchemaType getKnownBaseType()(Code) | | Returns the base type that this type inherits from. This method can be used to get the
base type of a type that is known to be valid.
If this type is a Simpletype that is a built in primitive type then null is returned.
the base type.
throws:
IllegalStateException - if this type is not valid. |
| getNameCode | | public int getNameCode()(Code) | | Get the namecode of the name of this type. This includes the prefix from the original
type declaration: in the case of built-in types, there may be a conventional prefix
or there may be no prefix.
|
| getPrimitiveItemType | | public ItemType getPrimitiveItemType()(Code) | | Get the primitive item type corresponding to this item type. For item(),
this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds,
it is the value representing the node kind, for example Type.ELEMENT.
For anyAtomicValue it is Type.ATOMIC_VALUE. For numeric it is Type.NUMBER.
For other atomic types it is the primitive type as defined in XML Schema,
except that INTEGER is considered to be a primitive type.
|
| getPrimitiveType | | public int getPrimitiveType()(Code) | | Get the primitive type corresponding to this item type. For item(),
this is Type.ITEM. For node(), it is Type.NODE. For specific node kinds,
it is the value representing the node kind, for example Type.ELEMENT.
For anyAtomicValue it is Type.ATOMIC. For numeric it is Type.NUMBER.
For other atomic types it is the primitive type as defined in XML Schema,
except that INTEGER is considered to be a primitive type.
|
| getTypedValue | | final public SequenceIterator getTypedValue(NodeInfo node)(Code) | | Get the typed value of a node that is annotated with this schema type
Parameters:
node - the node whose typed value is required an iterator over the items making up the typed value of this node. The objectsreturned by this SequenceIterator will all be of type net.sf.saxon.value.AtomicValue |
| getTypedValue | | public SequenceIterator getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) throws ValidationException(Code) | | Get the typed value corresponding to a given string value, assuming it is
valid against this type
Parameters:
value - the string value
Parameters:
resolver - a namespace resolver used to resolve any namespace prefixes appearingin the content of values. Can supply null, in which case any namespace-sensitive contentwill be rejected.
Parameters:
nameChecker - an iterator over the atomic sequence comprising the typed value. The objectsreturned by this SequenceIterator will all be of type net.sf.saxon.value.AtomicValue |
| getValidationStatus | | final public int getValidationStatus()(Code) | | Get the validation status - always valid
|
| getWhitespaceAction | | public int getWhitespaceAction(TypeHierarchy th)(Code) | | Determine the whitespace normalization required for values of this type
one of PRESERVE, REPLACE, COLLAPSE
Parameters:
th - |
| isAtomicType | | public boolean isAtomicType()(Code) | | Test whether this Simple Type is an atomic type
true, this is considered to be an atomic type |
| isBuiltIn | | public boolean isBuiltIn()(Code) | | |
| isComplexType | | final public boolean isComplexType()(Code) | | Test whether this SchemaType is a complex type
true if this SchemaType is a complex type |
| isListType | | public boolean isListType()(Code) | | 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
true if this is a list type |
| isNamespaceSensitive | | public boolean isNamespaceSensitive()(Code) | | Test whether this simple type is namespace-sensitive, that is, whether
it is derived from xs:QName or xs:NOTATION
true if this type is derived from xs:QName or xs:NOTATION |
| isSameType | | public boolean isSameType(SchemaType other)(Code) | | Test whether this is the same type as another type. They are considered to be the same type
if they are derived from the same type definition in the original XML representation (which
can happen when there are multiple includes of the same file)
|
| isSimpleType | | final public boolean isSimpleType()(Code) | | Returns true if this SchemaType is a SimpleType
true (always) |
| isTypeDerivationOK | | public void isTypeDerivationOK(SchemaType type, int block) throws SchemaException, ValidationException(Code) | | Check that this type is validly derived from a given type
Parameters:
type - the type from which this type is derived
Parameters:
block - the derivations that are blocked by the relevant element declaration
throws:
SchemaException - if the derivation is not allowed |
| isUnionType | | public boolean isUnionType()(Code) | | Return true if this type is a union type (that is, if its variety is union)
true for a union type |
| makeDerivedValue | | public AtomicValue makeDerivedValue(AtomicValue primValue, CharSequence lexicalValue, boolean validate)(Code) | | Factory method to create values of a derived atomic type. This method
is not used to create values of a built-in type, even one that is not
primitive.
Parameters:
primValue - the value in the value space of the primitive type
Parameters:
lexicalValue - the value in the lexical space. If null, the string value of primValue
Parameters:
validate - true if the value is to be validated against the facets of the derivedtype; false if the caller knows that the value is already valid. |
| toString | | public String toString(NamePool pool)(Code) | | Produce a representation of this type name for use in error messages.
Where this is a QName, it will use conventional prefixes
|
| validateContent | | public ValidationException validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)(Code) | | Check whether a given input string is valid according to this SimpleType
Parameters:
value - the input string to be checked
Parameters:
nsResolver - a namespace resolver used to resolve namespace prefixes if the typeis namespace sensitive. The value supplied may be null; in this case any namespace-sensitivecontent will throw an UnsupportedOperationException.
Parameters:
nameChecker - null if validation succeeds; return a ValidationException describing the validation failureif validation fails, unless throwException is true, in which case the exception is thrown rather thanbeing returned.
throws:
UnsupportedOperationException - if the type is namespace-sensitive and no namespaceresolver is supplied |
|
|