Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.type.BuiltInListType
Field Summary | |
static BuiltInListType | |
static BuiltInListType | |
static BuiltInListType | |
static BuiltInListType |
Fields inherited from interface net.sf.saxon.type.SchemaComponent | |
FIXED_UP , INCOMPLETE , INVALID , UNVALIDATED , VALIDATED , VALIDATING |
Fields inherited from interface net.sf.saxon.type.SchemaType | |
DERIVATION_EXTENSION , DERIVATION_LIST , DERIVATION_RESTRICTION , DERIVATION_UNION , DERIVE_BY_SUBSTITUTION |
Constructor Summary | |
|
Method Summary | |
boolean |
|
void |
|
String |
|
Value | |
void |
|
SchemaType |
|
int |
|
SchemaType |
|
AtomicType |
|
int |
|
String |
|
String |
|
int |
|
SimpleType |
|
SchemaType |
|
String |
|
String |
|
int |
|
String |
|
String |
|
SequenceIterator |
|
SequenceIterator |
|
int |
|
int |
|
static void |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
ValidationFailure |
|
public BuiltInListType(int fingerprint)
Create a new ListType.
- Parameters:
fingerprint
- identifies the name of the type
public boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property
- Specified by:
- allowsDerivation in interface SchemaType
- Parameters:
derivation
- the kind of derivation, for exampleSchemaType.DERIVATION_LIST
- Returns:
- true if this kind of derivation is allowed
public void analyzeContentExpression(Expression expression, int kind, StaticContext env) throws XPathException
Analyze an expression to see whether the expression is capable of delivering a value of this type.
- Specified by:
- analyzeContentExpression in interface SchemaType
- Parameters:
expression
- the expression that delivers the contentkind
- the node kind whose content is being delivered:Type.ELEMENT
,Type.ATTRIBUTE
, orType.DOCUMENT
env
- the XPath static context
- Throws:
XPathException
- if the expression will never deliver a value of the correct type
public String applyWhitespaceNormalization(String value)
Apply the whitespace normalization rules for this simple type
- Parameters:
value
- the string before whitespace normalization
- Returns:
- the string after whitespace normalization
public Value atomize(NodeInfo node) throws XPathException
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 methodgetTypedValue
. 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.
- Specified by:
- atomize in interface SchemaType
- Parameters:
node
- the node whose typed value is required
- Returns:
- the typed value.
- Since:
- 8.5
public void checkTypeDerivationIsOK(SchemaType type, int block) throws SchemaException
Check that this type is validly derived from a given type
- Specified by:
- checkTypeDerivationIsOK in interface SchemaType
- Parameters:
type
- the type from which this type is derivedblock
- the derivations that are blocked by the relevant element declaration
- Throws:
SchemaException
- if the derivation is not allowed
public SchemaType getBaseType()
Returns the base type that this type inherits from. If this type is a Simpletype that is a built in primitive type then null is returned.
- Specified by:
- getBaseType in interface SchemaType
- Returns:
- the base type.
public int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LIST
andSchemaType.DERIVATION_EXTENSION
- Specified by:
- getBlock in interface SchemaType
- Returns:
- the value of the 'block' attribute for this type
public SchemaType getBuiltInBaseType()
Get the built-in type from which this type is derived by restriction
- Specified by:
- getBuiltInBaseType in interface SimpleType
- Returns:
- the built-in type from which this type is derived by restriction. This will not necessarily be a primitive type.
public AtomicType getCommonAtomicType()
Get the most specific possible atomic type that all items in this SimpleType belong to
- Specified by:
- getCommonAtomicType in interface SimpleType
- Returns:
- the lowest common supertype of all member types
public int getDerivationMethod()
Gets the integer code of the derivation method used to derive this type from its parent. Returns zero for primitive types.
- Specified by:
- getDerivationMethod in interface SchemaType
- Returns:
- a numeric code representing the derivation method, for example
SchemaType.DERIVATION_RESTRICTION
public String getDescription()
Get a description of this type for use in error messages. This is the same as the display name in the case of named types; for anonymous types it identifies the type by its position in a source schema document.
- Specified by:
- getDescription in interface SchemaType
- Returns:
- text identifing the type, for use in a phrase such as "the type XXXX".
public String getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix
- Specified by:
- getDisplayName in interface SchemaType
- Returns:
- a lexical QName identifying the type
public int getFingerprint()
Get the fingerprint of the name of this type
- Specified by:
- getFingerprint in interface SchemaType
- Returns:
- the fingerprint. Returns an invented fingerprint for an anonymous type.
public SimpleType getItemType()
Returns the simpleType of the items in this ListType.
- Specified by:
- getItemType in interface ListType
- Returns:
- the simpleType of the items in this ListType.
public SchemaType getKnownBaseType() throws IllegalStateException
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.
- Returns:
- the base type.
public String getLocalName()
Get the local name of this type
- Returns:
- the local part of the name, or null if the type is anonymous
public String getName()
Get the local name of this type
- Specified by:
- getName in interface SchemaType
- Returns:
- the local name of this type definition, if it has one. Return null in the case of an anonymous type.
public int getNameCode()
Get the namecode of the name of this type. Because built-in types don't depend on the namePool, this actually returns the fingerprint, which contains no information about the namespace prefix
- Specified by:
- getNameCode in interface SchemaType
public String getSystemId()
Get the URI of the schema document containing the definition of this type
- Specified by:
- getSystemId in interface SchemaType
- Returns:
- null for a built-in type
public String getTargetNamespace()
Get the target namespace of this type
- Specified by:
- getTargetNamespace in interface SchemaType
- Returns:
- the target namespace of this type definition, if it has one. Return null in the case of an anonymous type, and in the case of a global type defined in a no-namespace schema.
public SequenceIterator getTypedValue(CharSequence value, NamespaceResolver resolver, NameChecker nameChecker) throws ValidationException
Get the typed value of a given input string. This method assumes that the input value is valid according to this SimpleType
- Specified by:
- getTypedValue in interface SimpleType
- Parameters:
value
- the string whose typed value is requiredresolver
- namespace resolver for namespace-sensitive contentnameChecker
- name checker for XML-version sensitive content
public SequenceIterator getTypedValue(NodeInfo node) throws XPathException
Get the typed value of a node that is annotated with this schema type. This method must be called only for a valid type.
- Specified by:
- getTypedValue in interface SchemaType
- Parameters:
node
- the node whose typed value is required
- Returns:
- a SequenceIterator over the atomic values making up the typed value of the specified node. The objects returned by this iterator are of type
AtomicValue
public int getValidationStatus()
Get the validation status - always valid
- Specified by:
- getValidationStatus in interface SchemaComponent
public int getWhitespaceAction(TypeHierarchy th)
Determine how values of this simple type are whitespace-normalized.
- Specified by:
- getWhitespaceAction in interface SimpleType
- Parameters:
th
- the type hierarchy cache
- Returns:
- one of
Whitespace.PRESERVE
,Whitespace.COLLAPSE
,Whitespace.REPLACE
.
public static void init()
Static initialization
public boolean isAnonymousType()
Test whether this is an anonymous type
- Specified by:
- isAnonymousType in interface SchemaType
- Returns:
- true if this SchemaType is an anonymous type
public boolean isAtomicType()
Test whether this Simple Type is an atomic type
- Specified by:
- isAtomicType in interface SimpleType
- isAtomicType in interface SchemaType
- Returns:
- false, this is not an atomic type
public boolean isBuiltInType()
Determine whether this is a built-in type or a user-defined type
- Specified by:
- isBuiltInType in interface SimpleType
public boolean isComplexType()
Test whether this SchemaType is a complex type
- Specified by:
- isComplexType in interface SchemaType
- Returns:
- true if this SchemaType is a complex type
public boolean isExternalType()
Return true if this is an external object type, that is, a Saxon-defined type for external Java or .NET objects
- Specified by:
- isExternalType in interface SimpleType
public 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
- Specified by:
- isListType in interface SimpleType
public boolean isNamespaceSensitive()
Test whether this type is namespace sensitive, that is, if a namespace context is needed to translate between the lexical space and the value space. This is true for types derived from, or containing, QNames and NOTATIONs
- Specified by:
- isNamespaceSensitive in interface SimpleType
- Returns:
- true if the type is namespace-sensitive
public boolean isSameType(SchemaType other)
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)
- Specified by:
- isSameType in interface SchemaType
public boolean isSimpleType()
Test whether this SchemaType is a simple type
- Specified by:
- isSimpleType in interface SchemaType
- Returns:
- true if this SchemaType is a simple type
public boolean isUnionType()
Test whether this Simple Type is a union type
- Specified by:
- isUnionType in interface SimpleType
- Returns:
- true if this is a union type
public ValidationFailure validateContent(CharSequence value, NamespaceResolver nsResolver, NameChecker nameChecker)
Check whether a given input string is valid according to this SimpleType
- Specified by:
- validateContent in interface SimpleType
- Parameters:
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, for types such as xs:NCName