Package net.sf.saxon.type
Enum Untyped
- java.lang.Object
-
- java.lang.Enum<Untyped>
-
- net.sf.saxon.type.Untyped
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<Untyped>,ComplexType,SchemaComponent,SchemaType
public enum Untyped extends java.lang.Enum<Untyped> implements ComplexType
This class has a singleton instance which represents the complex type xdt:untyped, used for elements that have not been validated.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.type.SchemaComponent
SchemaComponent.ValidationStatus
-
-
Enum Constant Summary
Enum Constants Enum Constant Description INSTANCE
-
Field Summary
Fields Modifier and Type Field Description static StructuredQNameNAME-
Fields inherited from interface net.sf.saxon.type.ComplexType
OPEN_CONTENT_ABSENT, OPEN_CONTENT_INTERLEAVE, OPEN_CONTENT_NONE, OPEN_CONTENT_SUFFIX, VARIETY_ELEMENT_ONLY, VARIETY_EMPTY, VARIETY_MIXED, VARIETY_SIMPLE
-
Fields inherited from interface net.sf.saxon.type.SchemaComponent
COMPONENT_FUNCTION_TYPE
-
Fields inherited from interface net.sf.saxon.type.SchemaType
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION, DERIVE_BY_SUBSTITUTION
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanallowsAttributes()Return true if this type (or any known type derived from it by extension) allows the element to have one or more attributes.booleanallowsDerivation(int derivation)Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" propertyvoidanalyzeContentExpression(Expression expression, int kind)Analyze an expression to see whether the expression is capable of delivering a value of this type.AtomicSequenceatomize(NodeInfo node)Get the typed value of a node that is annotated with this schema type.voidcheckTypeDerivationIsOK(SchemaType type, int block)Check that this type is validly derived from a given typebooleancontainsElementWildcard()Ask whether this type (or any known type derived from it by extension) allows the element to have children that match a wildcardvoidgatherAllPermittedChildren(IntHashSet children, boolean ignoreWildcards)Get a list of all the names of elements that can appear as children of an element having this complex type, as integer fingerprints.voidgatherAllPermittedDescendants(IntHashSet descendants)Get a list of all the names of elements that can appear as descendants of an element having this complex type, as integer fingerprints.intgetAttributeUseCardinality(StructuredQName attributeName)Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the cardinality associated with that attribute, which will always be 0, 1, or 0-or-1.SimpleTypegetAttributeUseType(StructuredQName attributeName)Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the schema type associated with that attribute.SchemaTypegetBaseType()Returns the base type that this type inherits from.intgetBlock()Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LISTandSchemaType.DERIVATION_EXTENSIONFunctiongetComponentAsFunction()Get the schema component in the form of a function item.intgetDerivationMethod()Gets the integer code of the derivation method used to derive this type from its parent.intgetDescendantElementCardinality(int elementFingerprint)Assuming an element is a permitted descendant in the content model of this type, determine the cardinality of the element when it appears as a descendant.SchemaTypegetDescendantElementType(int fingerprint)Assuming an element is a permitted descendant in the content model of this type, determine the type of the element when it appears as a descendant.java.lang.StringgetDescription()Get a description of this type for use in diagnosticsjava.lang.StringgetDisplayName()Get the display name of the type: that is, a lexical QName with an arbitrary prefixintgetElementParticleCardinality(int elementName, boolean considerExtensions)Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the cardinality associated with that element particle, that is, the number of times the element can occur within this complex type.SchemaTypegetElementParticleType(int elementName, boolean considerExtensions)Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the schema type associated with that element particle.java.lang.StringgetEQName()Get the name of this type as an EQName, that is, a string in the format Q{uri}local.intgetFinalProhibitions()Get the types of derivation that are not permitted, by virtue of the "final" property.intgetFingerprint()Get the fingerprint of the name of this typestatic UntypedgetInstance()Get the singular instance of this classSchemaTypegetKnownBaseType()Returns the base type that this type inherits from.java.lang.StringgetName()Get the local name of this typeintgetRedefinitionLevel()Get the redefinition level.SimpleTypegetSimpleContentType()For a complex type with simple content, return the simple type of the content.StructuredQNamegetStructuredQName()Get the name of the type as a StructuredQNamejava.lang.StringgetSystemId()Get the URI of the schema document containing the definition of this typejava.lang.StringgetTargetNamespace()Get the target namespace of this typeSchemaComponent.ValidationStatusgetValidationStatus()Get the validation status - always validintgetVariety()Get the variety of this complex type.booleanhasAssertions()Ask whether there are any assertions defined on this complex typebooleanisAbstract()Test whether this ComplexType has been marked as abstract.booleanisAllContent()Test whether this complex type has "all" content, that is, a content model using an xs:all compositorbooleanisAnonymousType()Test whether this is an anonymous typebooleanisAtomicType()Test whether this SchemaType is an atomic typebooleanisComplexContent()Test whether this complex type has complex contentbooleanisComplexType()Test whether this SchemaType is a complex typebooleanisEmptiable()Test whether the content model of this complexType allows empty contentbooleanisEmptyContent()Test whether the content type of this complex type is emptybooleanisIdRefType()Ask whether this type is an IDREF or IDREFS type.booleanisIdType()Ask whether this type is an ID type.booleanisMixedContent()Test whether this complex type allows mixed contentbooleanisRestricted()Test whether this complex type is derived by restrictionbooleanisSameType(SchemaType other)Test whether this is the same type as another type.booleanisSimpleContent()Test whether this complex type has simple contentbooleanisSimpleType()Test whether this SchemaType is a simple typestatic UntypedvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static Untyped[]values()Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface net.sf.saxon.type.SchemaType
getNearestNamedType
-
-
-
-
Enum Constant Detail
-
INSTANCE
public static final Untyped INSTANCE
-
-
Field Detail
-
NAME
public static final StructuredQName NAME
-
-
Method Detail
-
values
public static Untyped[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Untyped c : Untyped.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Untyped valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
getInstance
public static Untyped getInstance()
Get the singular instance of this class- Returns:
- the singular object representing xs:anyType
-
getValidationStatus
public SchemaComponent.ValidationStatus getValidationStatus()
Get the validation status - always valid- Specified by:
getValidationStatusin interfaceSchemaComponent- Returns:
- one of the values
SchemaComponent.ValidationStatus.UNVALIDATED,SchemaComponent.ValidationStatus.VALIDATING,SchemaComponent.ValidationStatus.VALIDATED,SchemaComponent.ValidationStatus.INVALID,SchemaComponent.ValidationStatus.INCOMPLETE
-
getName
public java.lang.String getName()
Get the local name of this type- Specified by:
getNamein interfaceSchemaType- Returns:
- the local name of this type definition, if it has one. Return null in the case of an anonymous type.
-
getEQName
public java.lang.String getEQName()
Get the name of this type as an EQName, that is, a string in the format Q{uri}local.- Specified by:
getEQNamein interfaceSchemaType- Returns:
- an EQName identifying the type, specifically "Q{http://www.w3.org/2001/XMLSchema}untyped"
-
getRedefinitionLevel
public int getRedefinitionLevel()
Get the redefinition level. This is zero for a component that has not been redefined; for a redefinition of a level-0 component, it is 1; for a redefinition of a level-N component, it is N+1. This concept is used to support the notion of "pervasive" redefinition: if a component is redefined at several levels, the top level wins, but it is an error to have two versions of the component at the same redefinition level.- Specified by:
getRedefinitionLevelin interfaceSchemaComponent- Returns:
- the redefinition level
-
getTargetNamespace
public java.lang.String getTargetNamespace()
Get the target namespace of this type- Specified by:
getTargetNamespacein interfaceSchemaType- 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.
-
getVariety
public int getVariety()
Get the variety of this complex type. This will be one of the valuesComplexType.VARIETY_EMPTY,ComplexType.VARIETY_MIXED,ComplexType.VARIETY_SIMPLE, orComplexType.VARIETY_ELEMENT_ONLY- Specified by:
getVarietyin interfaceComplexType
-
getSystemId
public java.lang.String getSystemId()
Get the URI of the schema document containing the definition of this type- Specified by:
getSystemIdin interfaceSchemaType- Returns:
- null for a built-in type
-
getBlock
public int getBlock()
Returns the value of the 'block' attribute for this type, as a bit-signnificant integer with fields such asSchemaType.DERIVATION_LISTandSchemaType.DERIVATION_EXTENSION- Specified by:
getBlockin interfaceSchemaType- Returns:
- the value of the 'block' attribute for this type
-
getDerivationMethod
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:
getDerivationMethodin interfaceSchemaType- Returns:
- a numeric code representing the derivation method, for example
SchemaType.DERIVATION_RESTRICTION
-
allowsDerivation
public boolean allowsDerivation(int derivation)
Determines whether derivation (of a particular kind) from this type is allowed, based on the "final" property- Specified by:
allowsDerivationin interfaceSchemaType- Parameters:
derivation- the kind of derivation, for exampleSchemaType.DERIVATION_LIST- Returns:
- true if this kind of derivation is allowed
-
getFinalProhibitions
public int getFinalProhibitions()
Get the types of derivation that are not permitted, by virtue of the "final" property.- Specified by:
getFinalProhibitionsin interfaceSchemaType- Returns:
- the types of derivation that are not permitted, as a bit-significant integer
containing bits such as
SchemaType.DERIVATION_EXTENSION
-
checkTypeDerivationIsOK
public void checkTypeDerivationIsOK(SchemaType type, int block)
Check that this type is validly derived from a given type- Specified by:
checkTypeDerivationIsOKin interfaceSchemaType- Parameters:
type- the type from which this type is derivedblock- the derivations that are blocked by the relevant element declaration
-
getFingerprint
public int getFingerprint()
Get the fingerprint of the name of this type- Specified by:
getFingerprintin interfaceSchemaType- Returns:
- the fingerprint. Returns an invented fingerprint for an anonymous type.
-
getDisplayName
public java.lang.String getDisplayName()
Get the display name of the type: that is, a lexical QName with an arbitrary prefix- Specified by:
getDisplayNamein interfaceSchemaType- Returns:
- a lexical QName identifying the type
-
getStructuredQName
public StructuredQName getStructuredQName()
Get the name of the type as a StructuredQName- Specified by:
getStructuredQNamein interfaceSchemaType- Returns:
- a StructuredQName identifying the type. In the case of an anonymous type, an internally-generated name is returned
-
isComplexType
public boolean isComplexType()
Test whether this SchemaType is a complex type- Specified by:
isComplexTypein interfaceSchemaType- Returns:
- true if this SchemaType is a complex type
-
isAnonymousType
public boolean isAnonymousType()
Test whether this is an anonymous type- Specified by:
isAnonymousTypein interfaceSchemaType- Returns:
- true if this SchemaType is an anonymous type
-
getKnownBaseType
public SchemaType getKnownBaseType() throws java.lang.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.
- Throws:
java.lang.IllegalStateException- if this type is not valid.
-
isSameType
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:
isSameTypein interfaceSchemaType- Parameters:
other- the other type- Returns:
- true if this is the same type as other
-
getBaseType
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:
getBaseTypein interfaceSchemaType- Returns:
- the base type.
-
isAbstract
public boolean isAbstract()
Test whether this ComplexType has been marked as abstract.- Specified by:
isAbstractin interfaceComplexType- Returns:
- false: this class is not abstract.
-
isSimpleType
public boolean isSimpleType()
Test whether this SchemaType is a simple type- Specified by:
isSimpleTypein interfaceSchemaType- Returns:
- true if this SchemaType is a simple type
-
isAtomicType
public boolean isAtomicType()
Test whether this SchemaType is an atomic type- Specified by:
isAtomicTypein interfaceSchemaType- Returns:
- true if this SchemaType is an atomic type
-
isIdType
public boolean isIdType()
Ask whether this type is an ID type. This is defined to be any simple type who typed value may contain atomic values of type xs:ID: that is, it includes types derived from ID by restriction, list, or union. Note that for a node to be treated as an ID, its typed value must be a *single* atomic value of type ID; the type of the node, however, can still allow a list.- Specified by:
isIdTypein interfaceSchemaType- Returns:
- true if this type is an ID type
-
isIdRefType
public boolean isIdRefType()
Ask whether this type is an IDREF or IDREFS type. This is defined to be any simple type who typed value may contain atomic values of type xs:IDREF: that is, it includes types derived from IDREF or IDREFS by restriction, list, or union- Specified by:
isIdRefTypein interfaceSchemaType- Returns:
- true if this type is an IDREF type
-
isComplexContent
public boolean isComplexContent()
Test whether this complex type has complex content- Specified by:
isComplexContentin interfaceComplexType- Returns:
- true: this complex type has complex content
-
isSimpleContent
public boolean isSimpleContent()
Test whether this complex type has simple content- Specified by:
isSimpleContentin interfaceComplexType- Returns:
- false: this complex type has complex content
-
isAllContent
public boolean isAllContent()
Test whether this complex type has "all" content, that is, a content model using an xs:all compositor- Specified by:
isAllContentin interfaceComplexType- Returns:
- false: this complex type does not use an "all" compositor
-
getSimpleContentType
public SimpleType getSimpleContentType()
For a complex type with simple content, return the simple type of the content. Otherwise, return null.- Specified by:
getSimpleContentTypein interfaceComplexType- Returns:
- null: this complex type does not have simple content
-
isRestricted
public boolean isRestricted()
Test whether this complex type is derived by restriction- Specified by:
isRestrictedin interfaceComplexType- Returns:
- true: this type is treated as a restriction of xs:anyType
-
isEmptyContent
public boolean isEmptyContent()
Test whether the content type of this complex type is empty- Specified by:
isEmptyContentin interfaceComplexType- Returns:
- false: the content model is not empty
-
isEmptiable
public boolean isEmptiable()
Test whether the content model of this complexType allows empty content- Specified by:
isEmptiablein interfaceComplexType- Returns:
- true: the content is allowed to be empty
-
isMixedContent
public boolean isMixedContent()
Test whether this complex type allows mixed content- Specified by:
isMixedContentin interfaceComplexType- Returns:
- true: mixed content is allowed
-
getDescription
public java.lang.String getDescription()
Get a description of this type for use in diagnostics- Specified by:
getDescriptionin interfaceSchemaType- Returns:
- the string "xs:anyType"
-
analyzeContentExpression
public void analyzeContentExpression(Expression expression, int kind)
Analyze an expression to see whether the expression is capable of delivering a value of this type.- Specified by:
analyzeContentExpressionin interfaceSchemaType- Parameters:
expression- the expression that delivers the contentkind- the node kind whose content is being delivered:Type.ELEMENT,Type.ATTRIBUTE, orType.DOCUMENT
-
atomize
public AtomicSequence atomize(NodeInfo node)
Get the typed value of a node that is annotated with this schema type.- Specified by:
atomizein interfaceSchemaType- Parameters:
node- the node whose typed value is required- Returns:
- the typed value.
- Since:
- 8.5
-
getElementParticleType
public SchemaType getElementParticleType(int elementName, boolean considerExtensions)
Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the schema type associated with that element particle. If there is no such particle, return null. If the fingerprint matches an element wildcard, return the type of the global element declaration with the given name if one exists, or AnyType if none exists and lax validation is permitted by the wildcard.- Specified by:
getElementParticleTypein interfaceComplexType- Parameters:
elementName- Identifies the name of the child element within this content modelconsiderExtensions- True if types derived from this type by extension are to be included in the search- Returns:
- the schema type associated with the child element particle with the given name. If there is no such particle, return null.
-
getElementParticleCardinality
public int getElementParticleCardinality(int elementName, boolean considerExtensions)Find an element particle within this complex type definition having a given element name (identified by fingerprint), and return the cardinality associated with that element particle, that is, the number of times the element can occur within this complex type. The value is one ofStaticProperty.EXACTLY_ONE,StaticProperty.ALLOWS_ZERO_OR_ONE,StaticProperty.ALLOWS_ZERO_OR_MORE,StaticProperty.ALLOWS_ONE_OR_MORE, If there is no such particle, return zero.- Specified by:
getElementParticleCardinalityin interfaceComplexType- Parameters:
elementName- Identifies the name of the child element within this content modelconsiderExtensions- True if types derived from this type by extension are to be included in the search- Returns:
- the cardinality associated with the child element particle with the given name.
If there is no such particle, return
StaticProperty.EMPTY.
-
getAttributeUseType
public SimpleType getAttributeUseType(StructuredQName attributeName)
Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the schema type associated with that attribute. If there is no such attribute use, return null. If the fingerprint matches an attribute wildcard, return the type of the global attribute declaration with the given name if one exists, or AnySimpleType if none exists and lax validation is permitted by the wildcard.- Specified by:
getAttributeUseTypein interfaceComplexType- Parameters:
attributeName- Identifies the name of the child element within this content model- Returns:
- the schema type associated with the attribute use identified by the fingerprint. If there is no such attribute use, return null.
-
getAttributeUseCardinality
public int getAttributeUseCardinality(StructuredQName attributeName)
Find an attribute use within this complex type definition having a given attribute name (identified by fingerprint), and return the cardinality associated with that attribute, which will always be 0, 1, or 0-or-1. If there is no such attribute use, return null. If the fingerprint matches an attribute wildcard, return the type of the global attribute declaration with the given name if one exists, or AnySimpleType if none exists and lax validation is permitted by the wildcard.If there are types derived from this type by extension, search those too.
- Specified by:
getAttributeUseCardinalityin interfaceComplexType- Parameters:
attributeName- Identifies the name of the child element within this content model- Returns:
- the schema type associated with the attribute use identified by the fingerprint. If there is no such attribute use, return null.
-
allowsAttributes
public boolean allowsAttributes()
Return true if this type (or any known type derived from it by extension) allows the element to have one or more attributes.- Specified by:
allowsAttributesin interfaceComplexType- Returns:
- true if attributes are allowed
-
gatherAllPermittedChildren
public void gatherAllPermittedChildren(IntHashSet children, boolean ignoreWildcards)
Get a list of all the names of elements that can appear as children of an element having this complex type, as integer fingerprints. If the list is unbounded (because of wildcards or the use of xs:anyType), return null.- Specified by:
gatherAllPermittedChildrenin interfaceComplexType- Parameters:
children- a set, initially empty, which on return will hold the names of all permitted child elements; if the result contains the value XS_INVALID_NAME, this indicates that it is not possible to enumerate all the children, typically because of wildcards. In this case the other contents of the set shouldignoreWildcards- True if wildcard particles in the content model should be ignored
-
gatherAllPermittedDescendants
public void gatherAllPermittedDescendants(IntHashSet descendants)
Get a list of all the names of elements that can appear as descendants of an element having this complex type, as integer fingerprints. If the list is unbounded (because of wildcards or the use of xs:anyType), return null.- Specified by:
gatherAllPermittedDescendantsin interfaceComplexType- Parameters:
descendants- an integer set, initially empty, which on return will hold the fingerprints of all permitted descendant elements; if the result contains the value XS_INVALID_NAME, this indicates that it is not possible to enumerate all the descendants, typically because of wildcards. In this case the other contents of the set should be ignored.
-
getDescendantElementType
public SchemaType getDescendantElementType(int fingerprint)
Assuming an element is a permitted descendant in the content model of this type, determine the type of the element when it appears as a descendant. If it appears with more than one type, return xs:anyType.- Specified by:
getDescendantElementTypein interfaceComplexType- Parameters:
fingerprint- the name of the required descendant element- Returns:
- the type of the descendant element; null if the element cannot appear as a descendant; anyType if it can appear with several different types
-
getDescendantElementCardinality
public int getDescendantElementCardinality(int elementFingerprint)
Assuming an element is a permitted descendant in the content model of this type, determine the cardinality of the element when it appears as a descendant.- Specified by:
getDescendantElementCardinalityin interfaceComplexType- Parameters:
elementFingerprint- the name of the required descendant element- Returns:
- the cardinality of the descendant element within this complex type
-
containsElementWildcard
public boolean containsElementWildcard()
Ask whether this type (or any known type derived from it by extension) allows the element to have children that match a wildcard- Specified by:
containsElementWildcardin interfaceComplexType- Returns:
- true if the content model of this type, or its extensions, contains an element wildcard
-
hasAssertions
public boolean hasAssertions()
Ask whether there are any assertions defined on this complex type- Specified by:
hasAssertionsin interfaceComplexType- Returns:
- true if there are any assertions
-
getComponentAsFunction
public Function getComponentAsFunction()
Get the schema component in the form of a function item. This allows schema information to be made visible to XSLT or XQuery code. The function makes available the contents of the schema component as defined in the XSD specification. The function takes a string as argument representing a property name, and returns the corresponding property of the schema component. There is also a property "class" which returns the kind of schema component, for example "Attribute Declaration".- Specified by:
getComponentAsFunctionin interfaceSchemaComponent- Returns:
- the schema component represented as a function from property names to property values.
-
-