Class XSElementDecl
- java.lang.Object
-
- org.smooks.engine.delivery.sax.ng.org.apache.xerces.impl.xs.XSElementDecl
-
- All Implemented Interfaces:
XSElementDeclaration,XSObject,XSTerm
public class XSElementDecl extends Object implements XSElementDeclaration
The XML representation for an element declaration schema component is an <element> element information item- Version:
- $Id$
- Author:
- Elena Litani, IBM, Sandy Gao, IBM
-
-
Field Summary
Fields Modifier and Type Field Description XSObjectListfAnnotationsshortfBlockValidatedInfofDefaultshortfFinalStringfNameshortfScopeXSElementDeclfSubGroupStringfTargetNamespaceXSTypeDefinitionfTypeQNamefUnresolvedTypeNamestatic shortSCOPE_ABSENTstatic shortSCOPE_GLOBALstatic shortSCOPE_LOCAL
-
Constructor Summary
Constructors Constructor Description XSElementDecl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddIDConstraint(IdentityConstraint idc)booleanequals(Object o)whether two decls are the samebooleangetAbstract(){abstract} A boolean.ObjectgetActualVC()Value Constraint: Binding specific actual constraint value ornullif the value is in error or there is no value constraint.shortgetActualVCType()The actual constraint value built-in datatype, e.g.XSAnnotationgetAnnotation()Optional.XSObjectListgetAnnotations()Optional.shortgetConstraintType()A value constraint: one of default, fixed.StringgetConstraintValue()A value constraint: The actual value (with respect to the {type definition})shortgetDisallowedSubstitutions()The supplied values for {disallowed substitutions}XSComplexTypeDefinitiongetEnclosingCTDefinition()Locally scoped declarations are available for use only within the complex type definition identified by thescopeproperty.IdentityConstraint[]getIDConstraints()XSNamedMapgetIdentityConstraints(){identity-constraint definitions} A set of constraint definitions.ShortListgetItemValueTypes()In the case the actual constraint value represents a list, i.e. theactualValueTypeisLIST_DT, the returned array consists of one type kind which represents the itemType.StringgetName()Thenameof thisXSObjectdepending on theXSObjecttype.StringgetNamespace()The namespace URI of this node, ornullif it is unspecified.XSNamespaceItemgetNamespaceItem()A namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornullotherwise.booleangetNillable()If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.shortgetScope()Optional.XSElementDeclarationgetSubstitutionGroupAffiliation(){substitution group affiliation} Optional.shortgetSubstitutionGroupExclusions()Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.shortgetType()Get the type of the object, i.e ELEMENT_DECLARATION.XSTypeDefinitiongetTypeDefinition()Either a simple type definition or a complex type definition.XSValuegetValueConstraintValue()The actual value of the default or fixed value constraint.inthashCode()get the hash codebooleanisDisallowedSubstitution(short disallowed)Convenience method.booleanisSubstitutionGroupExclusion(short exclusion)Convenience method.voidreset()Reset current element declarationvoidsetConstraintType(short constraintType)voidsetIsAbstract()voidsetIsGlobal()voidsetIsLocal(XSComplexTypeDecl enclosingCT)voidsetIsNillable()StringtoString()
-
-
-
Field Detail
-
SCOPE_ABSENT
public static final short SCOPE_ABSENT
- See Also:
- Constant Field Values
-
SCOPE_GLOBAL
public static final short SCOPE_GLOBAL
- See Also:
- Constant Field Values
-
SCOPE_LOCAL
public static final short SCOPE_LOCAL
- See Also:
- Constant Field Values
-
fName
public String fName
-
fTargetNamespace
public String fTargetNamespace
-
fType
public XSTypeDefinition fType
-
fUnresolvedTypeName
public QName fUnresolvedTypeName
-
fScope
public short fScope
-
fBlock
public short fBlock
-
fFinal
public short fFinal
-
fAnnotations
public XSObjectList fAnnotations
-
fDefault
public ValidatedInfo fDefault
-
fSubGroup
public XSElementDecl fSubGroup
-
-
Method Detail
-
setConstraintType
public void setConstraintType(short constraintType)
-
setIsNillable
public void setIsNillable()
-
setIsAbstract
public void setIsAbstract()
-
setIsGlobal
public void setIsGlobal()
-
setIsLocal
public void setIsLocal(XSComplexTypeDecl enclosingCT)
-
addIDConstraint
public void addIDConstraint(IdentityConstraint idc)
-
getIDConstraints
public IdentityConstraint[] getIDConstraints()
-
equals
public boolean equals(Object o)
whether two decls are the same
-
reset
public void reset()
Reset current element declaration
-
getType
public short getType()
Get the type of the object, i.e ELEMENT_DECLARATION.
-
getName
public String getName()
Thenameof thisXSObjectdepending on theXSObjecttype.
-
getNamespace
public String getNamespace()
The namespace URI of this node, ornullif it is unspecified. defines how a namespace URI is attached to schema components.- Specified by:
getNamespacein interfaceXSObject
-
getTypeDefinition
public XSTypeDefinition getTypeDefinition()
Either a simple type definition or a complex type definition.- Specified by:
getTypeDefinitionin interfaceXSElementDeclaration
-
getScope
public short getScope()
Optional. Either global or a complex type definition (ctDefinition). This property is absent in the case of declarations within named model groups: their scope will be determined when they are used in the construction of complex type definitions.- Specified by:
getScopein interfaceXSElementDeclaration
-
getEnclosingCTDefinition
public XSComplexTypeDefinition getEnclosingCTDefinition()
Locally scoped declarations are available for use only within the complex type definition identified by thescopeproperty.- Specified by:
getEnclosingCTDefinitionin interfaceXSElementDeclaration
-
getConstraintType
public short getConstraintType()
A value constraint: one of default, fixed.- Specified by:
getConstraintTypein interfaceXSElementDeclaration
-
getConstraintValue
public String getConstraintValue()
A value constraint: The actual value (with respect to the {type definition})- Specified by:
getConstraintValuein interfaceXSElementDeclaration
-
getNillable
public boolean getNillable()
If {nillable} is true, then an element may also be valid if it carries the namespace qualified attribute with [local name] nil from namespace http://www.w3.org/2001/XMLSchema-instance and value true (see xsi:nil (2.6.2)) even if it has no text or element content despite a {content type} which would otherwise require content.- Specified by:
getNillablein interfaceXSElementDeclaration
-
getIdentityConstraints
public XSNamedMap getIdentityConstraints()
{identity-constraint definitions} A set of constraint definitions.- Specified by:
getIdentityConstraintsin interfaceXSElementDeclaration
-
getSubstitutionGroupAffiliation
public XSElementDeclaration getSubstitutionGroupAffiliation()
{substitution group affiliation} Optional. A top-level element definition.- Specified by:
getSubstitutionGroupAffiliationin interfaceXSElementDeclaration
-
isSubstitutionGroupExclusion
public boolean isSubstitutionGroupExclusion(short exclusion)
Convenience method. Check ifexclusionis a substitution group exclusion for this element declaration.- Specified by:
isSubstitutionGroupExclusionin interfaceXSElementDeclaration- Parameters:
exclusion- Extension, restriction or none. Represents final set for the element.- Returns:
- True if
exclusionis a part of the substitution group exclusion subset.
-
getSubstitutionGroupExclusions
public short getSubstitutionGroupExclusions()
Specifies if this declaration can be nominated as the {substitution group affiliation} of other element declarations having the same {type definition} or types derived therefrom.- Specified by:
getSubstitutionGroupExclusionsin interfaceXSElementDeclaration- Returns:
- A bit flag representing {extension, restriction} or NONE.
-
isDisallowedSubstitution
public boolean isDisallowedSubstitution(short disallowed)
Convenience method. Check ifdisallowedis a disallowed substitution for this element declaration.- Specified by:
isDisallowedSubstitutionin interfaceXSElementDeclaration- Parameters:
disallowed- Substitution, extension, restriction or none. Represents a block set for the element.- Returns:
- True if
disallowedis a part of the substitution group exclusion subset.
-
getDisallowedSubstitutions
public short getDisallowedSubstitutions()
The supplied values for {disallowed substitutions}- Specified by:
getDisallowedSubstitutionsin interfaceXSElementDeclaration- Returns:
- A bit flag representing {substitution, extension, restriction} or NONE.
-
getAbstract
public boolean getAbstract()
{abstract} A boolean.- Specified by:
getAbstractin interfaceXSElementDeclaration
-
getAnnotation
public XSAnnotation getAnnotation()
Optional. Annotation.- Specified by:
getAnnotationin interfaceXSElementDeclaration
-
getAnnotations
public XSObjectList getAnnotations()
Optional. Annotations.- Specified by:
getAnnotationsin interfaceXSElementDeclaration
-
getNamespaceItem
public XSNamespaceItem getNamespaceItem()
Description copied from interface:XSObjectA namespace schema information item corresponding to the target namespace of the component, if it is globally declared; ornullotherwise.- Specified by:
getNamespaceItemin interfaceXSObject- See Also:
XSObject.getNamespaceItem()
-
getActualVC
public Object getActualVC()
Description copied from interface:XSElementDeclarationValue Constraint: Binding specific actual constraint value ornullif the value is in error or there is no value constraint.- Specified by:
getActualVCin interfaceXSElementDeclaration
-
getActualVCType
public short getActualVCType()
Description copied from interface:XSElementDeclarationThe actual constraint value built-in datatype, e.g.STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returnsLIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returnsLISTOFUNION_DT. To query the actual constraint value of the list or list of union type definitions useitemValueTypes. If theactualNormalizedValueisnull, this method returnsUNAVAILABLE_DT.- Specified by:
getActualVCTypein interfaceXSElementDeclaration
-
getItemValueTypes
public ShortList getItemValueTypes()
Description copied from interface:XSElementDeclarationIn the case the actual constraint value represents a list, i.e. theactualValueTypeisLIST_DT, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e.LISTOFUNION_DT, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, seeItemPSVI.itemValueTypes.- Specified by:
getItemValueTypesin interfaceXSElementDeclaration
-
getValueConstraintValue
public XSValue getValueConstraintValue()
Description copied from interface:XSElementDeclarationThe actual value of the default or fixed value constraint.- Specified by:
getValueConstraintValuein interfaceXSElementDeclaration
-
-