Class SchemaTypeImpl
- java.lang.Object
-
- org.apache.xmlbeans.impl.schema.SchemaTypeImpl
-
- All Implemented Interfaces:
TypeStoreUserFactory,SchemaAnnotated,SchemaComponent,SchemaType
public final class SchemaTypeImpl extends Object implements SchemaType, TypeStoreUserFactory
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.xmlbeans.SchemaType
SchemaType.Ref
-
-
Field Summary
-
Fields inherited from interface org.apache.xmlbeans.SchemaComponent
ANNOTATION, ATTRIBUTE, ATTRIBUTE_GROUP, ELEMENT, IDENTITY_CONSTRAINT, MODEL_GROUP, NOTATION, TYPE
-
Fields inherited from interface org.apache.xmlbeans.SchemaType
ATOMIC, BTC_ANY_SIMPLE, BTC_ANY_TYPE, BTC_ANY_URI, BTC_BASE_64_BINARY, BTC_BOOLEAN, BTC_BYTE, BTC_DATE, BTC_DATE_TIME, BTC_DECIMAL, BTC_DOUBLE, BTC_DURATION, BTC_ENTITIES, BTC_ENTITY, BTC_FIRST_PRIMITIVE, BTC_FLOAT, BTC_G_DAY, BTC_G_MONTH, BTC_G_MONTH_DAY, BTC_G_YEAR, BTC_G_YEAR_MONTH, BTC_HEX_BINARY, BTC_ID, BTC_IDREF, BTC_IDREFS, BTC_INT, BTC_INTEGER, BTC_LANGUAGE, BTC_LAST_BUILTIN, BTC_LAST_PRIMITIVE, BTC_LONG, BTC_NAME, BTC_NCNAME, BTC_NEGATIVE_INTEGER, BTC_NMTOKEN, BTC_NMTOKENS, BTC_NON_NEGATIVE_INTEGER, BTC_NON_POSITIVE_INTEGER, BTC_NORMALIZED_STRING, BTC_NOT_BUILTIN, BTC_NOTATION, BTC_POSITIVE_INTEGER, BTC_QNAME, BTC_SHORT, BTC_STRING, BTC_TIME, BTC_TOKEN, BTC_UNSIGNED_BYTE, BTC_UNSIGNED_INT, BTC_UNSIGNED_LONG, BTC_UNSIGNED_SHORT, DT_EXTENSION, DT_NOT_DERIVED, DT_RESTRICTION, ELEMENT_CONTENT, EMPTY_CONTENT, FACET_ENUMERATION, FACET_FRACTION_DIGITS, FACET_LENGTH, FACET_MAX_EXCLUSIVE, FACET_MAX_INCLUSIVE, FACET_MAX_LENGTH, FACET_MIN_EXCLUSIVE, FACET_MIN_INCLUSIVE, FACET_MIN_LENGTH, FACET_PATTERN, FACET_TOTAL_DIGITS, FACET_WHITE_SPACE, LAST_BASIC_FACET, LAST_FACET, LAST_PROPERTY, LIST, MIXED_CONTENT, NOT_COMPLEX_TYPE, NOT_DECIMAL, NOT_SIMPLE, PARTIAL_ORDER, PROPERTY_BOUNDED, PROPERTY_CARDINALITY, PROPERTY_NUMERIC, PROPERTY_ORDERED, SIMPLE_CONTENT, SIZE_BIG_DECIMAL, SIZE_BIG_INTEGER, SIZE_BYTE, SIZE_INT, SIZE_LONG, SIZE_SHORT, TOTAL_ORDER, UNION, UNORDERED, WS_COLLAPSE, WS_PRESERVE, WS_REPLACE, WS_UNSPECIFIED
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSubstitutionGroupMember(QName member)booleanblockExtension()True if extensions of this type cannot be substituted for this typebooleanblockRestriction()True if restrictions of this type cannot be substituted for this typevoidcopyEnumerationValues(SchemaTypeImpl baseImpl)XmlObjectcreateAttributeType(QName attrName, SchemaTypeLoader wildcardTypeLoader)XmlObjectcreateElementType(QName eltName, QName xsiType, SchemaTypeLoader wildcardTypeLoader)TypeStoreUsercreateTypeStoreUser()TypeStoreUserFactory implementationXmlObjectcreateUnwrappedNode()SchemaStringEnumEntryenumEntryForString(String s)Returns the string enum entry corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.StringEnumAbstractBaseenumForInt(int i)Returns the string enum value corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.StringEnumAbstractBaseenumForString(String s)Returns the string enum value corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.booleanfinalExtension()True if other types cannot extend this type (only for complex types)booleanfinalList()True if list derivation of this type is prohibited (only for simple types)booleanfinalRestriction()True if other types cannot restrict this typebooleanfinalUnion()True if union derivation of this type is prohibited (only for simple types)voidfinishJavaizing()voidfinishLoading()voidfinishResolving()voidfinishResolvingSGs()SchemaAnnotationgetAnnotation()Returns the Schema annotation object or null if none presentSchemaType[]getAnonymousTypes()The array of inner (anonymous) types defined within this type.intgetAnonymousUnionMemberOrdinal()For anonymous types defined inside a union only: gets the integer indicating the declaration order of this type within the outer union type, or zero if this is not applicable.StringgetAttFormDefault()SchemaAttributeModelgetAttributeModel()Returns the attribute model for this complex type (with simple or complex content).SchemaProperty[]getAttributeProperties()Returns all the SchemaProperties corresponding to attributes.SchemaPropertygetAttributeProperty(QName attrName)Returns a SchemaProperty corresponding to an attribute within this complex type by looking up the attribute name.SchemaTypegetAttributeType(QName attrName, SchemaTypeLoader wildcardTypeLoader)Returns the type of an attribute based on the attribute name and the type system within which (wildcard) names are resolved.QNamegetAttributeTypeAttributeName()Returns the attribute qname if this is a attribute type, or null otherwise.intgetBaseDepth()SchemaTypegetBaseEnumType()If this is a string enumeration, returns the most basic base schema type that this enuemration is based on.SchemaTypegetBaseType()Returns base restriction or extension type.XmlAnySimpleType[]getBasicFacets()intgetBuiltinTypeCode()Returns an integer for builtin types that can be used for quick comparison.StringgetChameleonNamespace()SchemaTypegetCommonBaseType(SchemaType type)Returns common base type with the given type.SchemaComponent.RefgetComponentRef()Used for on-demand loading of schema components.intgetComponentType()Returns the type code for the schema object, eitherSchemaComponent.TYPE,SchemaComponent.ELEMENT,SchemaComponent.ATTRIBUTE,SchemaComponent.ATTRIBUTE_GROUP,SchemaComponent.MODEL_GROUP,SchemaComponent.IDENTITY_CONSTRAINT, orSchemaComponent.NOTATION.SchemaFieldgetContainerField()The parent schema element.SchemaTypegetContentBasedOnType()For complex types with simple content returns the base type for this type's content.SchemaParticlegetContentModel()Returns the complex content model for this complex type (with complex content).intgetContentType()ReturnsSchemaType.EMPTY_CONTENT,SchemaType.SIMPLE_CONTENT,SchemaType.ELEMENT_CONTENT, orSchemaType.MIXED_CONTENTfor complex types.intgetDecimalSize()For atomic numeric restrictions of decimal only: the numeric size category.intgetDerivationType()Returns an integer for the derivation type, eitherSchemaType.DT_EXTENSION,SchemaType.DT_RESTRICTION,SchemaType.DT_NOT_DERIVED.SchemaProperty[]getDerivedProperties()Returns the SchemaProperties defined by this complex type, exclusive of the base type (if any).StringgetDocumentation()returns user specified documentationQNamegetDocumentElementName()Returns the document element name if this is a document type, or null otherwise.SchemaProperty[]getElementProperties()Returns all the SchemaProperties corresponding to elements.SchemaPropertygetElementProperty(QName eltName)Returns a SchemaProperty corresponding to an element within this complex type by looking up the element name.SchemaTypeElementSequencergetElementSequencer()Returns aSchemaTypeElementSequencerobject, which can then be used to validate complex content inside this element.SchemaTypegetElementType(QName eltName, QName xsiType, SchemaTypeLoader wildcardTypeLoader)Returns the type of a child element based on the element name and an xsi:type attribute (and the type system within which names are resolved).StringgetElemFormDefault()XmlAnySimpleType[]getEnumerationValues()Returns the array of valid objects from the enumeration facet, null if no enumeration defined.Class<? extends StringEnumAbstractBase>getEnumJavaClass()The Java class corresponding to the enumeration type for this schema type, if applicable (or null if not an enumeration).XmlAnySimpleTypegetFacet(int facetCode)Returns the value of the given facet, or null if none is set.boolean[]getFixedFacets()StringgetFullJavaImplName()The fully-qualified Java type name of the implementation class.StringgetFullJavaName()The fully-qualified Java type name of the class.intgetIndexForLocalAttribute(SchemaLocalAttribute attr)intgetIndexForLocalElement(SchemaLocalElement elt)InterfaceExtension[]getInterfaceExtensions()Class<? extends XmlObject>getJavaClass()The Java class corresponding to this schema type.Class<? extends XmlObjectBase>getJavaImplClass()Constructor<? extends XmlObjectBase>getJavaImplConstructor()Constructor<? extends XmlObjectBase>getJavaImplConstructor2()SchemaTypegetListItemType()For list types only: get the item type.SchemaLocalElementgetLocalElementByIndex(int i)QNamegetName()The name used to describe the type in the schema.SchemaTypegetOuterType()The outer schema type.XmlObjectgetParseObject()RegularExpression[]getPatternExpressions()String[]getPatterns()TruePrePostExtensiongetPrePostExtension()SchemaTypegetPrimitiveType()For atomic types only: get the primitive type underlying this one.SchemaProperty[]getProperties()Returns all the SchemaProperties within this complex type, elements followed by attributes.SchemaType.RefgetRef()Retruns a SchemaType.Ref pointing to this schema type itself.StringgetShortJavaImplName()The short unqualfiied Java name for the implementation class.StringgetShortJavaName()The short unqualfiied Java name for the class.intgetSimpleVariety()Returns whether the simple type is ATOMIC, UNION, or LIST.StringgetSourceName()The name of resource that represends the source .xsd in which this component was defined (if known)
See:SchemaTypeLoader.getSourceAsStream(String)
Example:SchemaStringEnumEntry[]getStringEnumEntries()Returns the array of SchemaStringEnumEntries for this type: this array includes information about the java constant names used for each string enum entry.QNamegetSubstitutionGroup()QName[]getSubstitutionGroupMembers()StringgetTargetNamespace()SchemaTypeSystemgetTypeSystem()Returns the SchemaTypeLoader in which this type was defined.SchemaTypegetUnionCommonBaseType()For union types only: get the most specific common base type of the constituent member types.SchemaType[]getUnionConstituentTypes()For union types only: get the constituent member types.SchemaType[]getUnionMemberTypes()For union types only: get the shallow member types.SchemaType[]getUnionSubTypes()For union types only: gets the full tree of member types.ObjectgetUserData()Returns user-specific information.StringgetUserTypeHandlerName()StringgetUserTypeName()intgetWhiteSpaceRule()For nonunion simple types: get the whitespace rule.booleanhasAllContent()True if the complex content model for this complex type is an "all" group.booleanhasAttributeWildcards()True if this type permits wildcard attributes.booleanhasElementWildcards()True if this type permits element wildcards.booleanhasPatternFacet()True if there are regex pattern facentsbooleanhasStringEnumValues()True if this is a string enum where an integer is assigned to each enumerated value.booleanisAbstract()True if this type cannot be used directly in instancesbooleanisAnonymousType()True if the Xsd type is anonymous (i.e., not top-level).booleanisAssignableFrom(SchemaType type)True if the specified type derives from this type (or if it is the same type).booleanisAttributeType()True if this is a attribute type.booleanisBounded()True if bounded.booleanisBuiltinType()True for any of the 40+ built-in types.booleanisChameleon()booleanisCompiled()True if this schema type was compiled to have a corresponding Java class.booleanisDocumentType()True if this is a document type.booleanisFacetFixed(int facetCode)True if the given facet is fixed.booleanisFinite()True if finite.booleanisJavaized()booleanisNoType()True for the type object that represents a the absence of a determined type.booleanisNumeric()True if numeric.booleanisOrderSensitive()True if particles have same defaults, nillability, etc, that are invariant when order changes.booleanisPrimitiveType()True for any of the 20 primitive types (plus anySimpleType)booleanisRedefinition()booleanisResolved()booleanisResolving()booleanisSGResolved()booleanisSGResolving()booleanisSimpleType()True for the anySimpleType and any restrictions/unions/lists.booleanisSkippedAnonymousType()True if this anonymous type has no corresponding Java type.booleanisUnionOfLists()booleanisUnjavaized()booleanisUnloaded()booleanisURType()True for anyType and anySimpleType.booleanisValidSubstitution(QName name)For document types, true if the given name can be substituted for the document element name.booleanmatchPatternFacet(String s)True if the given string matches the pattern facets.XmlAnySimpleTypenewValidatingValue(Object obj)XmlAnySimpleTypenewValue(Object obj)Creates an immutable simple value.XmlAnySimpleTypenewValue(Object obj, boolean validateOnSet)intordered()True if ordered.QNameSetqnameSetForWildcardAttributes()Returns a QNameSet of attributes that may exist in wildcard buchets and are not explicitly defined in this schema type.QNameSetqnameSetForWildcardElements()Returns a QNameSet of elements that may exist in wildcard buchets and are not explicitly defined in this schema type.voidsetAnnotation(SchemaAnnotation ann)voidsetAnonymousTypeRefs(SchemaType.Ref[] anonymousTyperefs)voidsetAnonymousUnionMemberOrdinal(int i)voidsetAttributeType(boolean isAttribute)voidsetBaseDepth(int depth)voidsetBaseEnumTypeRef(SchemaType.Ref baseEnumTyperef)voidsetBaseTypeRef(SchemaType.Ref typeref)voidsetBasicFacets(XmlValueRef[] values, boolean[] fixed)voidsetBounded(boolean f)voidsetBuiltinTypeCode(int builtinTypeCode)voidsetCompiled(boolean f)voidsetComplexTypeVariety(int complexTypeVariety)voidsetContainerField(SchemaField field)voidsetContainerFieldIndex(short code, int index)voidsetContainerFieldRef(SchemaComponent.Ref ref)voidsetContentBasedOnTypeRef(SchemaType.Ref typeref)voidsetContentModel(SchemaParticle contentModel, SchemaAttributeModel attrModel, Map<QName,SchemaProperty> propertyModelByElementName, Map<QName,SchemaProperty> propertyModelByAttributeName, boolean isAll)voidsetDecimalSize(int bits)voidsetDerivationType(int type)voidsetDocumentType(boolean isDocument)voidsetEnumerationValues(XmlValueRef[] a)voidsetFilename(String filename)voidsetFinite(boolean f)voidsetFullJavaImplName(String name)voidsetFullJavaName(String name)voidsetInterfaceExtensions(InterfaceExtension[] interfaces)voidsetJavaClass(Class<? extends XmlObject> javaClass)voidsetListItemTypeRef(SchemaType.Ref typeref)voidsetName(QName name)voidsetNumeric(boolean f)voidsetOrdered(int ordering)voidsetOrderSensitive(boolean sensitive)voidsetOuterSchemaTypeRef(SchemaType.Ref typeref)voidsetParseContext(XmlObject parseObject, String targetNamespace, boolean chameleon, String elemFormDefault, String attFormDefault, boolean redefinition)voidsetPatternFacet(boolean hasPatterns)voidsetPatterns(RegularExpression[] list)voidsetPrePostExtension(PrePostExtension prepost)voidsetPrimitiveTypeRef(SchemaType.Ref typeref)voidsetShortJavaImplName(String name)voidsetShortJavaName(String name)voidsetSimpleType(boolean f)voidsetSimpleTypeVariety(int variety)voidsetStringEnumEntries(SchemaStringEnumEntry[] sEnums)voidsetSubstitutionGroup(QName sg)voidsetUnionMemberTypeRefs(SchemaType.Ref[] typerefs)voidsetUnionOfLists(boolean f)voidsetUserData(Object data)voidsetUserTypeHandlerName(String typeHandler)voidsetUserTypeName(String userTypeName)voidsetWhiteSpaceRule(int ws)voidsetWildcardSummary(QNameSet elementSet, boolean haswcElt, QNameSet attributeSet, boolean haswcAtt)voidstartJavaizing()voidstartResolving()voidstartResolvingSGs()StringtoString()
-
-
-
Method Detail
-
isUnloaded
public boolean isUnloaded()
-
finishLoading
public void finishLoading()
-
isSGResolved
public boolean isSGResolved()
-
isSGResolving
public boolean isSGResolving()
-
isResolved
public boolean isResolved()
-
isResolving
public boolean isResolving()
-
isUnjavaized
public boolean isUnjavaized()
-
isJavaized
public boolean isJavaized()
-
startResolvingSGs
public void startResolvingSGs()
-
finishResolvingSGs
public void finishResolvingSGs()
-
startResolving
public void startResolving()
-
finishResolving
public void finishResolving()
-
startJavaizing
public void startJavaizing()
-
finishJavaizing
public void finishJavaizing()
-
getName
public QName getName()
Description copied from interface:SchemaTypeThe name used to describe the type in the schema. Null if the type is anonymous (nested), or if it is a document type.- Specified by:
getNamein interfaceSchemaComponent- Specified by:
getNamein interfaceSchemaType
-
setName
public void setName(QName name)
-
getSourceName
public String getSourceName()
Description copied from interface:SchemaComponentThe name of resource that represends the source .xsd in which this component was defined (if known)
See:SchemaTypeLoader.getSourceAsStream(String)
Example:SchemaType schemaType = ..; InputStream is = schemaType.getTypeSystem().getSourceAsStream(schemaType.getSourceName());
- Specified by:
getSourceNamein interfaceSchemaComponent
-
setFilename
public void setFilename(String filename)
-
getComponentType
public int getComponentType()
Description copied from interface:SchemaComponentReturns the type code for the schema object, eitherSchemaComponent.TYPE,SchemaComponent.ELEMENT,SchemaComponent.ATTRIBUTE,SchemaComponent.ATTRIBUTE_GROUP,SchemaComponent.MODEL_GROUP,SchemaComponent.IDENTITY_CONSTRAINT, orSchemaComponent.NOTATION.- Specified by:
getComponentTypein interfaceSchemaComponent
-
isAnonymousType
public boolean isAnonymousType()
Description copied from interface:SchemaTypeTrue if the Xsd type is anonymous (i.e., not top-level).- Specified by:
isAnonymousTypein interfaceSchemaType
-
isDocumentType
public boolean isDocumentType()
Description copied from interface:SchemaTypeTrue if this is a document type.Document types are generated for every global element. A document type is an unnamed complex type that contains exactly one element: we define these types, because they are the types of the "documents" which contain the defined global elements, and they all turn into Java types. (Named ElementnameDocument.)
- Specified by:
isDocumentTypein interfaceSchemaType
-
isAttributeType
public boolean isAttributeType()
Description copied from interface:SchemaTypeTrue if this is a attribute type.Attribute types are generated for every global attribute. An attribute type is an unnamed complex type that contains exactly one attribute: we define these types, because they are the types of the "attribute documents" which contain the defined global attribute, and they all turn into Java types. (Named AttributenameAttribute.)
- Specified by:
isAttributeTypein interfaceSchemaType
-
getDocumentElementName
public QName getDocumentElementName()
Description copied from interface:SchemaTypeReturns the document element name if this is a document type, or null otherwise.- Specified by:
getDocumentElementNamein interfaceSchemaType
-
getAttributeTypeAttributeName
public QName getAttributeTypeAttributeName()
Description copied from interface:SchemaTypeReturns the attribute qname if this is a attribute type, or null otherwise.- Specified by:
getAttributeTypeAttributeNamein interfaceSchemaType
-
setAnnotation
public void setAnnotation(SchemaAnnotation ann)
-
getAnnotation
public SchemaAnnotation getAnnotation()
Description copied from interface:SchemaAnnotatedReturns the Schema annotation object or null if none present- Specified by:
getAnnotationin interfaceSchemaAnnotated
-
setDocumentType
public void setDocumentType(boolean isDocument)
-
setAttributeType
public void setAttributeType(boolean isAttribute)
-
getContentType
public int getContentType()
Description copied from interface:SchemaTypeReturnsSchemaType.EMPTY_CONTENT,SchemaType.SIMPLE_CONTENT,SchemaType.ELEMENT_CONTENT, orSchemaType.MIXED_CONTENTfor complex types. For noncomplex types, returnsSchemaType.NOT_COMPLEX_TYPE.- Specified by:
getContentTypein interfaceSchemaType
-
setComplexTypeVariety
public void setComplexTypeVariety(int complexTypeVariety)
-
getElementSequencer
public SchemaTypeElementSequencer getElementSequencer()
Description copied from interface:SchemaTypeReturns aSchemaTypeElementSequencerobject, which can then be used to validate complex content inside this element. This is useful for example for trying out different names and see which one would be valid as a child of this element.- Specified by:
getElementSequencerin interfaceSchemaType
-
blockRestriction
public boolean blockRestriction()
Description copied from interface:SchemaTypeTrue if restrictions of this type cannot be substituted for this type- Specified by:
blockRestrictionin interfaceSchemaType
-
blockExtension
public boolean blockExtension()
Description copied from interface:SchemaTypeTrue if extensions of this type cannot be substituted for this type- Specified by:
blockExtensionin interfaceSchemaType
-
isAbstract
public boolean isAbstract()
Description copied from interface:SchemaTypeTrue if this type cannot be used directly in instances- Specified by:
isAbstractin interfaceSchemaType
-
finalExtension
public boolean finalExtension()
Description copied from interface:SchemaTypeTrue if other types cannot extend this type (only for complex types)- Specified by:
finalExtensionin interfaceSchemaType
-
finalRestriction
public boolean finalRestriction()
Description copied from interface:SchemaTypeTrue if other types cannot restrict this type- Specified by:
finalRestrictionin interfaceSchemaType
-
finalList
public boolean finalList()
Description copied from interface:SchemaTypeTrue if list derivation of this type is prohibited (only for simple types)- Specified by:
finalListin interfaceSchemaType
-
finalUnion
public boolean finalUnion()
Description copied from interface:SchemaTypeTrue if union derivation of this type is prohibited (only for simple types)- Specified by:
finalUnionin interfaceSchemaType
-
getContainerField
public SchemaField getContainerField()
Description copied from interface:SchemaTypeThe parent schema element. Null for top-level (named) types and document types.- Specified by:
getContainerFieldin interfaceSchemaType
-
setContainerField
public void setContainerField(SchemaField field)
-
setContainerFieldRef
public void setContainerFieldRef(SchemaComponent.Ref ref)
-
setContainerFieldIndex
public void setContainerFieldIndex(short code, int index)
-
getOuterType
public SchemaType getOuterType()
Description copied from interface:SchemaTypeThe outer schema type. Null for top-level (named) types.- Specified by:
getOuterTypein interfaceSchemaType
-
setOuterSchemaTypeRef
public void setOuterSchemaTypeRef(SchemaType.Ref typeref)
-
isCompiled
public boolean isCompiled()
Description copied from interface:SchemaTypeTrue if this schema type was compiled to have a corresponding Java class.- Specified by:
isCompiledin interfaceSchemaType
-
setCompiled
public void setCompiled(boolean f)
-
isSkippedAnonymousType
public boolean isSkippedAnonymousType()
Description copied from interface:SchemaTypeTrue if this anonymous type has no corresponding Java type. True for anonymous types nested within simple type restrictions.- Specified by:
isSkippedAnonymousTypein interfaceSchemaType
-
getShortJavaName
public String getShortJavaName()
Description copied from interface:SchemaTypeThe short unqualfiied Java name for the class.- Specified by:
getShortJavaNamein interfaceSchemaType
-
setShortJavaName
public void setShortJavaName(String name)
-
getFullJavaName
public String getFullJavaName()
Description copied from interface:SchemaTypeThe fully-qualified Java type name of the class.- Specified by:
getFullJavaNamein interfaceSchemaType
-
setFullJavaName
public void setFullJavaName(String name)
-
setShortJavaImplName
public void setShortJavaImplName(String name)
-
setFullJavaImplName
public void setFullJavaImplName(String name)
-
getFullJavaImplName
public String getFullJavaImplName()
Description copied from interface:SchemaTypeThe fully-qualified Java type name of the implementation class.- Specified by:
getFullJavaImplNamein interfaceSchemaType
-
getShortJavaImplName
public String getShortJavaImplName()
Description copied from interface:SchemaTypeThe short unqualfiied Java name for the implementation class.- Specified by:
getShortJavaImplNamein interfaceSchemaType
-
getUserTypeName
public String getUserTypeName()
-
setUserTypeName
public void setUserTypeName(String userTypeName)
-
getUserTypeHandlerName
public String getUserTypeHandlerName()
-
setUserTypeHandlerName
public void setUserTypeHandlerName(String typeHandler)
-
setInterfaceExtensions
public void setInterfaceExtensions(InterfaceExtension[] interfaces)
-
getInterfaceExtensions
public InterfaceExtension[] getInterfaceExtensions()
-
setPrePostExtension
public void setPrePostExtension(PrePostExtension prepost)
-
getPrePostExtension
public PrePostExtension getPrePostExtension()
-
getUserData
public Object getUserData()
Description copied from interface:SchemaTypeReturns user-specific information.- Specified by:
getUserDatain interfaceSchemaType- See Also:
SchemaBookmark
-
setUserData
public void setUserData(Object data)
-
getTypeSystem
public SchemaTypeSystem getTypeSystem()
Description copied from interface:SchemaTypeReturns the SchemaTypeLoader in which this type was defined. Complex types are defined and used in exactly one schema type system, but simple types are defined in one type system and can be used in any number of type systems. The most common case is the builtin types, which are defined in the builtin type system and used elsewhere.- Specified by:
getTypeSystemin interfaceSchemaComponent- Specified by:
getTypeSystemin interfaceSchemaType
-
getContentModel
public SchemaParticle getContentModel()
Description copied from interface:SchemaTypeReturns the complex content model for this complex type (with complex content).- Specified by:
getContentModelin interfaceSchemaType
-
getLocalElementByIndex
public SchemaLocalElement getLocalElementByIndex(int i)
-
getIndexForLocalElement
public int getIndexForLocalElement(SchemaLocalElement elt)
-
getIndexForLocalAttribute
public int getIndexForLocalAttribute(SchemaLocalAttribute attr)
-
getAttributeModel
public SchemaAttributeModel getAttributeModel()
Description copied from interface:SchemaTypeReturns the attribute model for this complex type (with simple or complex content).- Specified by:
getAttributeModelin interfaceSchemaType
-
getProperties
public SchemaProperty[] getProperties()
Description copied from interface:SchemaTypeReturns all the SchemaProperties within this complex type, elements followed by attributes.- Specified by:
getPropertiesin interfaceSchemaType
-
getDerivedProperties
public SchemaProperty[] getDerivedProperties()
Description copied from interface:SchemaTypeReturns the SchemaProperties defined by this complex type, exclusive of the base type (if any).- Specified by:
getDerivedPropertiesin interfaceSchemaType
-
getElementProperties
public SchemaProperty[] getElementProperties()
Description copied from interface:SchemaTypeReturns all the SchemaProperties corresponding to elements.- Specified by:
getElementPropertiesin interfaceSchemaType
-
getAttributeProperties
public SchemaProperty[] getAttributeProperties()
Description copied from interface:SchemaTypeReturns all the SchemaProperties corresponding to attributes.- Specified by:
getAttributePropertiesin interfaceSchemaType
-
getElementProperty
public SchemaProperty getElementProperty(QName eltName)
Description copied from interface:SchemaTypeReturns a SchemaProperty corresponding to an element within this complex type by looking up the element name.- Specified by:
getElementPropertyin interfaceSchemaType
-
getAttributeProperty
public SchemaProperty getAttributeProperty(QName attrName)
Description copied from interface:SchemaTypeReturns a SchemaProperty corresponding to an attribute within this complex type by looking up the attribute name.- Specified by:
getAttributePropertyin interfaceSchemaType
-
hasAllContent
public boolean hasAllContent()
Description copied from interface:SchemaTypeTrue if the complex content model for this complex type is an "all" group.- Specified by:
hasAllContentin interfaceSchemaType
-
isOrderSensitive
public boolean isOrderSensitive()
Description copied from interface:SchemaTypeTrue if particles have same defaults, nillability, etc, that are invariant when order changes. Computed only for Javaized types.- Specified by:
isOrderSensitivein interfaceSchemaType
-
setOrderSensitive
public void setOrderSensitive(boolean sensitive)
-
setContentModel
public void setContentModel(SchemaParticle contentModel, SchemaAttributeModel attrModel, Map<QName,SchemaProperty> propertyModelByElementName, Map<QName,SchemaProperty> propertyModelByAttributeName, boolean isAll)
-
hasAttributeWildcards
public boolean hasAttributeWildcards()
Description copied from interface:SchemaTypeTrue if this type permits wildcard attributes. See the attribute model for more information about which wildcards are allowed.- Specified by:
hasAttributeWildcardsin interfaceSchemaType
-
hasElementWildcards
public boolean hasElementWildcards()
Description copied from interface:SchemaTypeTrue if this type permits element wildcards. See the content model for more information about which wildcards are allowed, and where.- Specified by:
hasElementWildcardsin interfaceSchemaType
-
isValidSubstitution
public boolean isValidSubstitution(QName name)
Description copied from interface:SchemaTypeFor document types, true if the given name can be substituted for the document element name.- Specified by:
isValidSubstitutionin interfaceSchemaType
-
getElementType
public SchemaType getElementType(QName eltName, QName xsiType, SchemaTypeLoader wildcardTypeLoader)
Description copied from interface:SchemaTypeReturns the type of a child element based on the element name and an xsi:type attribute (and the type system within which names are resolved).- Specified by:
getElementTypein interfaceSchemaType
-
getAttributeType
public SchemaType getAttributeType(QName attrName, SchemaTypeLoader wildcardTypeLoader)
Description copied from interface:SchemaTypeReturns the type of an attribute based on the attribute name and the type system within which (wildcard) names are resolved.- Specified by:
getAttributeTypein interfaceSchemaType
-
createElementType
public XmlObject createElementType(QName eltName, QName xsiType, SchemaTypeLoader wildcardTypeLoader)
-
createAttributeType
public XmlObject createAttributeType(QName attrName, SchemaTypeLoader wildcardTypeLoader)
-
setWildcardSummary
public void setWildcardSummary(QNameSet elementSet, boolean haswcElt, QNameSet attributeSet, boolean haswcAtt)
-
getAnonymousTypes
public SchemaType[] getAnonymousTypes()
Description copied from interface:SchemaTypeThe array of inner (anonymous) types defined within this type.- Specified by:
getAnonymousTypesin interfaceSchemaType
-
setAnonymousTypeRefs
public void setAnonymousTypeRefs(SchemaType.Ref[] anonymousTyperefs)
-
setSimpleTypeVariety
public void setSimpleTypeVariety(int variety)
-
getSimpleVariety
public int getSimpleVariety()
Description copied from interface:SchemaTypeReturns whether the simple type is ATOMIC, UNION, or LIST. ReturnsSchemaType.NOT_SIMPLE,SchemaType.ATOMIC,SchemaType.UNION, orSchemaType.LIST.- Specified by:
getSimpleVarietyin interfaceSchemaType
-
isURType
public boolean isURType()
Description copied from interface:SchemaTypeTrue for anyType and anySimpleType.- Specified by:
isURTypein interfaceSchemaType
-
isNoType
public boolean isNoType()
Description copied from interface:SchemaTypeTrue for the type object that represents a the absence of a determined type. XML Objects whose type isNoType() are never valid.- Specified by:
isNoTypein interfaceSchemaType
-
isSimpleType
public boolean isSimpleType()
Description copied from interface:SchemaTypeTrue for the anySimpleType and any restrictions/unions/lists.- Specified by:
isSimpleTypein interfaceSchemaType
-
setSimpleType
public void setSimpleType(boolean f)
-
isUnionOfLists
public boolean isUnionOfLists()
-
setUnionOfLists
public void setUnionOfLists(boolean f)
-
getPrimitiveType
public SchemaType getPrimitiveType()
Description copied from interface:SchemaTypeFor atomic types only: get the primitive type underlying this one.Returns null if this is not an atomic type.
- Specified by:
getPrimitiveTypein interfaceSchemaType
-
setPrimitiveTypeRef
public void setPrimitiveTypeRef(SchemaType.Ref typeref)
-
getDecimalSize
public int getDecimalSize()
Description copied from interface:SchemaTypeFor atomic numeric restrictions of decimal only: the numeric size category. Takes into account min and max restrictions as well as totalDigits and fractionDigits facets.Returns either
SchemaType.NOT_DECIMAL,SchemaType.SIZE_BYTE,SchemaType.SIZE_SHORT,SchemaType.SIZE_INT,SchemaType.SIZE_LONG,SchemaType.SIZE_BIG_INTEGER, orSchemaType.SIZE_BIG_DECIMAL.- Specified by:
getDecimalSizein interfaceSchemaType
-
setDecimalSize
public void setDecimalSize(int bits)
-
getBaseType
public SchemaType getBaseType()
Description copied from interface:SchemaTypeReturns base restriction or extension type. Unions and lists return the anySimpleType.- Specified by:
getBaseTypein interfaceSchemaType
-
setBaseTypeRef
public void setBaseTypeRef(SchemaType.Ref typeref)
-
getBaseDepth
public int getBaseDepth()
-
setBaseDepth
public void setBaseDepth(int depth)
-
getContentBasedOnType
public SchemaType getContentBasedOnType()
Description copied from interface:SchemaTypeFor complex types with simple content returns the base type for this type's content. In most cases, this is the same as the base type, but it can also be an anonymous type.- Specified by:
getContentBasedOnTypein interfaceSchemaType
-
setContentBasedOnTypeRef
public void setContentBasedOnTypeRef(SchemaType.Ref typeref)
-
getDerivationType
public int getDerivationType()
Description copied from interface:SchemaTypeReturns an integer for the derivation type, eitherSchemaType.DT_EXTENSION,SchemaType.DT_RESTRICTION,SchemaType.DT_NOT_DERIVED.- Specified by:
getDerivationTypein interfaceSchemaType
-
setDerivationType
public void setDerivationType(int type)
-
getListItemType
public SchemaType getListItemType()
Description copied from interface:SchemaTypeFor list types only: get the item type. This is the atomic or union type that is the type of every entry in the list.Returns null if this type is not a list.
- Specified by:
getListItemTypein interfaceSchemaType
-
setListItemTypeRef
public void setListItemTypeRef(SchemaType.Ref typeref)
-
getUnionMemberTypes
public SchemaType[] getUnionMemberTypes()
Description copied from interface:SchemaTypeFor union types only: get the shallow member types. This returns the declared member types of the union, so, for example if the type contains another union, the nested members of that union are NOT returned here.Returns null if this type is not a union.
- Specified by:
getUnionMemberTypesin interfaceSchemaType
-
setUnionMemberTypeRefs
public void setUnionMemberTypeRefs(SchemaType.Ref[] typerefs)
-
getAnonymousUnionMemberOrdinal
public int getAnonymousUnionMemberOrdinal()
Description copied from interface:SchemaTypeFor anonymous types defined inside a union only: gets the integer indicating the declaration order of this type within the outer union type, or zero if this is not applicable. The first anonymous union member within a union type is numbered "1". Used to differentiate between different anonymous types.- Specified by:
getAnonymousUnionMemberOrdinalin interfaceSchemaType
-
setAnonymousUnionMemberOrdinal
public void setAnonymousUnionMemberOrdinal(int i)
-
getUnionConstituentTypes
public SchemaType[] getUnionConstituentTypes()
Description copied from interface:SchemaTypeFor union types only: get the constituent member types. This returns only non-union types, so, for example, for unions of unions, this returns the flattened list of individual member types within the innermost unions.Returns null if this type is not a union.
- Specified by:
getUnionConstituentTypesin interfaceSchemaType
-
getUnionSubTypes
public SchemaType[] getUnionSubTypes()
Description copied from interface:SchemaTypeFor union types only: gets the full tree of member types. This computes the closure of the set returned by getUnionMemberTypes(), so, for example, it returns all the types nested within unions of unions as well as the top-level members; the set also includes the type itself. If you are seeking only the basic non-union consituents, use getUnionConstituentTypes.Returns null if this type is not a union.
- Specified by:
getUnionSubTypesin interfaceSchemaType
-
getUnionCommonBaseType
public SchemaType getUnionCommonBaseType()
Description copied from interface:SchemaTypeFor union types only: get the most specific common base type of the constituent member types. May return a UR type.Returns null if this type is not a union.
- Specified by:
getUnionCommonBaseTypein interfaceSchemaType
-
getSubstitutionGroup
public QName getSubstitutionGroup()
-
setSubstitutionGroup
public void setSubstitutionGroup(QName sg)
-
addSubstitutionGroupMember
public void addSubstitutionGroupMember(QName member)
-
getSubstitutionGroupMembers
public QName[] getSubstitutionGroupMembers()
-
getWhiteSpaceRule
public int getWhiteSpaceRule()
Description copied from interface:SchemaTypeFor nonunion simple types: get the whitespace rule. This is eitherSchemaType.WS_PRESERVE,SchemaType.WS_REPLACE, orSchemaType.WS_COLLAPSE. ReturnsSchemaType.WS_UNSPECIFIEDfor unions and complex types.- Specified by:
getWhiteSpaceRulein interfaceSchemaType
-
setWhiteSpaceRule
public void setWhiteSpaceRule(int ws)
-
getFacet
public XmlAnySimpleType getFacet(int facetCode)
Description copied from interface:SchemaTypeReturns the value of the given facet, or null if none is set.- Specified by:
getFacetin interfaceSchemaType
-
isFacetFixed
public boolean isFacetFixed(int facetCode)
Description copied from interface:SchemaTypeTrue if the given facet is fixed.- Specified by:
isFacetFixedin interfaceSchemaType
-
getBasicFacets
public XmlAnySimpleType[] getBasicFacets()
-
getFixedFacets
public boolean[] getFixedFacets()
-
setBasicFacets
public void setBasicFacets(XmlValueRef[] values, boolean[] fixed)
-
ordered
public int ordered()
Description copied from interface:SchemaTypeTrue if ordered. Returns eitherSchemaType.UNORDERED,SchemaType.PARTIAL_ORDER, orSchemaType.TOTAL_ORDER.- Specified by:
orderedin interfaceSchemaType
-
setOrdered
public void setOrdered(int ordering)
-
isBounded
public boolean isBounded()
Description copied from interface:SchemaTypeTrue if bounded.- Specified by:
isBoundedin interfaceSchemaType
-
setBounded
public void setBounded(boolean f)
-
isFinite
public boolean isFinite()
Description copied from interface:SchemaTypeTrue if finite.- Specified by:
isFinitein interfaceSchemaType
-
setFinite
public void setFinite(boolean f)
-
isNumeric
public boolean isNumeric()
Description copied from interface:SchemaTypeTrue if numeric.- Specified by:
isNumericin interfaceSchemaType
-
setNumeric
public void setNumeric(boolean f)
-
hasPatternFacet
public boolean hasPatternFacet()
Description copied from interface:SchemaTypeTrue if there are regex pattern facents- Specified by:
hasPatternFacetin interfaceSchemaType
-
setPatternFacet
public void setPatternFacet(boolean hasPatterns)
-
matchPatternFacet
public boolean matchPatternFacet(String s)
Description copied from interface:SchemaTypeTrue if the given string matches the pattern facets. Always true if there are no pattern facets.- Specified by:
matchPatternFacetin interfaceSchemaType
-
getPatterns
public String[] getPatterns()
Description copied from interface:SchemaTypeTrue- Specified by:
getPatternsin interfaceSchemaType
-
getPatternExpressions
public RegularExpression[] getPatternExpressions()
-
setPatterns
public void setPatterns(RegularExpression[] list)
-
getEnumerationValues
public XmlAnySimpleType[] getEnumerationValues()
Description copied from interface:SchemaTypeReturns the array of valid objects from the enumeration facet, null if no enumeration defined.- Specified by:
getEnumerationValuesin interfaceSchemaType
-
setEnumerationValues
public void setEnumerationValues(XmlValueRef[] a)
-
enumForString
public StringEnumAbstractBase enumForString(String s)
Description copied from interface:SchemaTypeReturns the string enum value corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.- Specified by:
enumForStringin interfaceSchemaType
-
enumForInt
public StringEnumAbstractBase enumForInt(int i)
Description copied from interface:SchemaTypeReturns the string enum value corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.- Specified by:
enumForIntin interfaceSchemaType
-
enumEntryForString
public SchemaStringEnumEntry enumEntryForString(String s)
Description copied from interface:SchemaTypeReturns the string enum entry corresponding to the given enumerated string, or null if there is no match or this type is not a string enumeration.- Specified by:
enumEntryForStringin interfaceSchemaType
-
getBaseEnumType
public SchemaType getBaseEnumType()
Description copied from interface:SchemaTypeIf this is a string enumeration, returns the most basic base schema type that this enuemration is based on. Otherwise returns null.- Specified by:
getBaseEnumTypein interfaceSchemaType
-
setBaseEnumTypeRef
public void setBaseEnumTypeRef(SchemaType.Ref baseEnumTyperef)
-
getStringEnumEntries
public SchemaStringEnumEntry[] getStringEnumEntries()
Description copied from interface:SchemaTypeReturns the array of SchemaStringEnumEntries for this type: this array includes information about the java constant names used for each string enum entry.- Specified by:
getStringEnumEntriesin interfaceSchemaType
-
setStringEnumEntries
public void setStringEnumEntries(SchemaStringEnumEntry[] sEnums)
-
hasStringEnumValues
public boolean hasStringEnumValues()
Description copied from interface:SchemaTypeTrue if this is a string enum where an integer is assigned to each enumerated value.- Specified by:
hasStringEnumValuesin interfaceSchemaType
-
copyEnumerationValues
public void copyEnumerationValues(SchemaTypeImpl baseImpl)
-
getBuiltinTypeCode
public int getBuiltinTypeCode()
Description copied from interface:SchemaTypeReturns an integer for builtin types that can be used for quick comparison.- Specified by:
getBuiltinTypeCodein interfaceSchemaType
-
setBuiltinTypeCode
public void setBuiltinTypeCode(int builtinTypeCode)
-
getJavaClass
public Class<? extends XmlObject> getJavaClass()
Description copied from interface:SchemaTypeThe Java class corresponding to this schema type.- Specified by:
getJavaClassin interfaceSchemaType
-
getJavaImplClass
public Class<? extends XmlObjectBase> getJavaImplClass()
-
getJavaImplConstructor
public Constructor<? extends XmlObjectBase> getJavaImplConstructor()
-
getJavaImplConstructor2
public Constructor<? extends XmlObjectBase> getJavaImplConstructor2()
-
getEnumJavaClass
public Class<? extends StringEnumAbstractBase> getEnumJavaClass()
Description copied from interface:SchemaTypeThe Java class corresponding to the enumeration type for this schema type, if applicable (or null if not an enumeration).- Specified by:
getEnumJavaClassin interfaceSchemaType
-
isPrimitiveType
public boolean isPrimitiveType()
Description copied from interface:SchemaTypeTrue for any of the 20 primitive types (plus anySimpleType)- Specified by:
isPrimitiveTypein interfaceSchemaType
-
isBuiltinType
public boolean isBuiltinType()
Description copied from interface:SchemaTypeTrue for any of the 40+ built-in types.- Specified by:
isBuiltinTypein interfaceSchemaType
-
createUnwrappedNode
public XmlObject createUnwrappedNode()
-
createTypeStoreUser
public TypeStoreUser createTypeStoreUser()
TypeStoreUserFactory implementation- Specified by:
createTypeStoreUserin interfaceTypeStoreUserFactory
-
newValidatingValue
public XmlAnySimpleType newValidatingValue(Object obj)
-
newValue
public XmlAnySimpleType newValue(Object obj)
Creates an immutable simple value.- Specified by:
newValuein interfaceSchemaType
-
newValue
public XmlAnySimpleType newValue(Object obj, boolean validateOnSet)
-
getCommonBaseType
public SchemaType getCommonBaseType(SchemaType type)
Description copied from interface:SchemaTypeReturns common base type with the given type. The returned type is the most specific declared base type of both types.- Specified by:
getCommonBaseTypein interfaceSchemaType
-
isAssignableFrom
public boolean isAssignableFrom(SchemaType type)
Description copied from interface:SchemaTypeTrue if the specified type derives from this type (or if it is the same type).Note that XmlObject.type (the anyType) is assignable from all type, and the XmlBeans.noType (the absence of a type) is assignable to all types.
- Specified by:
isAssignableFromin interfaceSchemaType
-
setParseContext
public void setParseContext(XmlObject parseObject, String targetNamespace, boolean chameleon, String elemFormDefault, String attFormDefault, boolean redefinition)
-
getParseObject
public XmlObject getParseObject()
-
getTargetNamespace
public String getTargetNamespace()
-
isChameleon
public boolean isChameleon()
-
getElemFormDefault
public String getElemFormDefault()
-
getAttFormDefault
public String getAttFormDefault()
-
getChameleonNamespace
public String getChameleonNamespace()
-
isRedefinition
public boolean isRedefinition()
-
getRef
public SchemaType.Ref getRef()
Description copied from interface:SchemaTypeRetruns a SchemaType.Ref pointing to this schema type itself.- Specified by:
getRefin interfaceSchemaType
-
getComponentRef
public SchemaComponent.Ref getComponentRef()
Description copied from interface:SchemaComponentUsed for on-demand loading of schema components.- Specified by:
getComponentRefin interfaceSchemaComponent
-
qnameSetForWildcardElements
public QNameSet qnameSetForWildcardElements()
Returns a QNameSet of elements that may exist in wildcard buchets and are not explicitly defined in this schema type. Note: In this example:
the returned QNameSet will not contain the qname of 'someElement'.<xs:complexType name="exampleType"> <xs:sequence> <xs:element name="someElement" type='xs:string' /> <xs:any namespace="##targetNamespace" /> </xs:sequence> </xs:complexType>- Specified by:
qnameSetForWildcardElementsin interfaceSchemaType- Returns:
- the constructed QNameSet
-
qnameSetForWildcardAttributes
public QNameSet qnameSetForWildcardAttributes()
Returns a QNameSet of attributes that may exist in wildcard buchets and are not explicitly defined in this schema type. Note: In this example:
the returned QNameSet will not contain the qname of 'someAttribute'.<xs:complexType name="exampleType"> ... <xs:attribute name='someAttribute' type='xs:string' /> <xs:anyAttribute namespace="##targetNamespace" /> </xs:complexType>- Specified by:
qnameSetForWildcardAttributesin interfaceSchemaType- Returns:
- the constructed QNameSet
-
getDocumentation
public String getDocumentation()
Description copied from interface:SchemaTypereturns user specified documentation<xs:complexType ...> <xs:annotation> <xs:documentation> getDocumentation method will return whatever stuff here. </xs:docmentation> </xs:annotation> </xs complexType>- Specified by:
getDocumentationin interfaceSchemaType
-
-