Class ElementDecl

java.lang.Object

com.sun.xml.xsom.impl.ComponentImpl

com.sun.xml.xsom.impl.DeclarationImpl

com.sun.xml.xsom.impl.ElementDecl

All Implemented Interfaces:

Ref.Term, XSComponent, XSDeclaration, XSElementDecl, XSTerm

public class ElementDecl
extends DeclarationImpl
implements XSElementDecl, Ref.Term

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	_abstract
private XmlString	defaultValue
private XmlString	fixedValue
private Boolean	form
private final List<XSIdentityConstraint>	idConstraints
private boolean	nillable
private int	substDisallowed
private int	substExcluded
private Ref.Element	substHead
private Set<XSElementDecl>	substitutables	Set that represents element decls that can substitute this element.
private Set<XSElementDecl>	substitutablesView	Unmodifieable view of substitutables.
private Ref.Type	type

Fields inherited from class ComponentImpl

ownerDocument

Constructor Summary

Constructors

Constructor	Description
ElementDecl(PatcherManager reader, SchemaDocumentImpl owner, AnnotationImpl _annon, Locator _loc, ForeignAttributesImpl fa, String _tns, String _name, boolean _anonymous, XmlString _defv, XmlString _fixedv, boolean _nillable, boolean _abstract, Boolean _form, Ref.Type _type, Ref.Element _substHead, int _substDisallowed, int _substExcluded, List<IdentityConstraintImpl> idConstraints)

Method Summary

Modifier and Type	Method	Description
protected void	addSubstitutable(ElementDecl decl)
Object	apply(XSFunction function)	Accepts a functor.
Object	apply(XSTermFunction function)
<T,P> T	apply(XSTermFunctionWithParam<T,P> function, P param)
XSElementDecl	asElementDecl()
XSModelGroup	asModelGroup()
XSModelGroupDecl	asModelGroupDecl()
XSWildcard	asWildcard()
boolean	canBeSubstitutedBy(XSElementDecl e)	Returns true if this element declaration can be validly substituted by the given declaration.
XmlString	getDefaultValue()
XmlString	getFixedValue()
Boolean	getForm()	Used for javadoc schema generation
List<XSIdentityConstraint>	getIdentityConstraints()	Returns all the XSIdentityConstraints in this element decl.
XSElementDecl	getSubstAffiliation()	Gets the substitution head of this element, if any.
Set<? extends XSElementDecl>	getSubstitutables()	Returns the element declarations that can substitute this element.
XSTerm	getTerm()	Obtains a reference as a term.
XSType	getType()	Gets the type of this element declaration.
boolean	isAbstract()
boolean	isElementDecl()
boolean	isModelGroup()
boolean	isModelGroupDecl()
boolean	isNillable()
boolean	isSubstitutionDisallowed(int method)	Checks the diallowed substitution property of the schema component.
boolean	isSubstitutionExcluded(int method)	Checks the substitution excluded property of the schema component.
boolean	isWildcard()
XSElementDecl[]	listSubstitutables()	Deprecated.
void	updateSubstitutabilityMap()
void	visit(XSTermVisitor visitor)
void	visit(XSVisitor visitor)	Accepts a visitor.

Methods inherited from class DeclarationImpl

getName, getTargetNamespace, isAnonymous, isGlobal, isLocal

Methods inherited from class ComponentImpl

getAnnotation, getAnnotation, getForeignAttribute, getForeignAttributes, getLocator, getOwnerSchema, getRoot, getSourceDocument, select, selectSingle, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface XSComponent

getAnnotation, getAnnotation, getForeignAttribute, getForeignAttributes, getLocator, getOwnerSchema, getRoot, getSourceDocument, select, selectSingle

Methods inherited from interface XSDeclaration

getName, getTargetNamespace, isAnonymous, isGlobal, isLocal

Field Details

defaultValue

private XmlString defaultValue

fixedValue

private XmlString fixedValue

nillable

private boolean nillable

_abstract

private boolean _abstract

type

private Ref.Type type

substHead

private Ref.Element substHead

substDisallowed

private int substDisallowed

substExcluded

private int substExcluded

idConstraints

private final List<XSIdentityConstraint> idConstraints

form

private Boolean form

substitutables

private Set<XSElementDecl> substitutables

Set that represents element decls that can substitute this element.

substitutablesView

private Set<XSElementDecl> substitutablesView

Unmodifieable view of substitutables.

Constructor Details

ElementDecl

public ElementDecl(PatcherManager reader,
 SchemaDocumentImpl owner,
 AnnotationImpl _annon,
 Locator _loc,
 ForeignAttributesImpl fa,
 String _tns,
 String _name,
 boolean _anonymous,
 XmlString _defv,
 XmlString _fixedv,
 boolean _nillable,
 boolean _abstract,
 Boolean _form,
 Ref.Type _type,
 Ref.Element _substHead,
 int _substDisallowed,
 int _substExcluded,
 List<IdentityConstraintImpl> idConstraints)

Method Details

getDefaultValue

public XmlString getDefaultValue()

Specified by:

getDefaultValue in interface XSElementDecl

getFixedValue

public XmlString getFixedValue()

Specified by:

getFixedValue in interface XSElementDecl

isNillable

public boolean isNillable()

Specified by:

isNillable in interface XSElementDecl

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface XSElementDecl

getType

public XSType getType()

Description copied from interface: XSElementDecl

Gets the type of this element declaration.

Specified by:

getType in interface XSElementDecl

Returns:

always non-null.

getSubstAffiliation

public XSElementDecl getSubstAffiliation()

Description copied from interface: XSElementDecl

Gets the substitution head of this element, if any. Otherwise null.

Specified by:

getSubstAffiliation in interface XSElementDecl

isSubstitutionDisallowed

public boolean isSubstitutionDisallowed(int method)

Description copied from interface: XSElementDecl

Checks the diallowed substitution property of the schema component. IOW, this checks the value of the block attribute (plus blockDefault).

Specified by:

isSubstitutionDisallowed in interface XSElementDecl

Parameters:

method - Possible values are XSType.EXTENSION, XSType.RESTRICTION, or XSType.SUBSTITUTION

isSubstitutionExcluded

public boolean isSubstitutionExcluded(int method)

Description copied from interface: XSElementDecl

Checks the substitution excluded property of the schema component. IOW, this checks the value of the final attribute (plus finalDefault).

Specified by:

isSubstitutionExcluded in interface XSElementDecl

Parameters:

method - Possible values are XSType.EXTENSION or XSType.RESTRICTION.

getIdentityConstraints

public List<XSIdentityConstraint> getIdentityConstraints()

Description copied from interface: XSElementDecl

Returns all the XSIdentityConstraints in this element decl.

Specified by:

getIdentityConstraints in interface XSElementDecl

Returns:

never null, but can be empty.

getForm

public Boolean getForm()

Description copied from interface: XSElementDecl

Used for javadoc schema generation

Specified by:

getForm in interface XSElementDecl

Returns:

null if form attribute not present, true if form attribute present and set to qualified, false if form attribute present and set to unqualified.

listSubstitutables

public XSElementDecl[] listSubstitutables()

Deprecated.

Description copied from interface: XSElementDecl

Returns the element declarations that can substitute this element.

IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint.

Specified by:

listSubstitutables in interface XSElementDecl

Returns:

nun-null valid array. The return value always contains this element decl itself.

getSubstitutables

public Set<? extends XSElementDecl> getSubstitutables()

Description copied from interface: XSElementDecl

Returns the element declarations that can substitute this element.

IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint.

Note that the above clause does NOT check for abstract elements. So abstract elements may still show up in the returned set.

Specified by:

getSubstitutables in interface XSElementDecl

Returns:

nun-null unmodifiable list. The returned list always contains this element decl itself.

addSubstitutable

protected void addSubstitutable(ElementDecl decl)

updateSubstitutabilityMap

public void updateSubstitutabilityMap()

canBeSubstitutedBy

public boolean canBeSubstitutedBy(XSElementDecl e)

Description copied from interface: XSElementDecl

Returns true if this element declaration can be validly substituted by the given declaration.

Just a short cut of getSubstitutables().contain(e);

Specified by:

canBeSubstitutedBy in interface XSElementDecl

isWildcard

public boolean isWildcard()

Specified by:

isWildcard in interface XSTerm

isModelGroupDecl

public boolean isModelGroupDecl()

Specified by:

isModelGroupDecl in interface XSTerm

isModelGroup

public boolean isModelGroup()

Specified by:

isModelGroup in interface XSTerm

isElementDecl

public boolean isElementDecl()

Specified by:

isElementDecl in interface XSTerm

asWildcard

public XSWildcard asWildcard()

Specified by:

asWildcard in interface XSTerm

asModelGroupDecl

public XSModelGroupDecl asModelGroupDecl()

Specified by:

asModelGroupDecl in interface XSTerm

asModelGroup

public XSModelGroup asModelGroup()

Specified by:

asModelGroup in interface XSTerm

asElementDecl

public XSElementDecl asElementDecl()

Specified by:

asElementDecl in interface XSTerm

visit

public void visit(XSVisitor visitor)

Description copied from interface: XSComponent

Accepts a visitor.

Specified by:

visit in interface XSComponent

visit

public void visit(XSTermVisitor visitor)

Specified by:

visit in interface XSTerm

apply

public Object apply(XSTermFunction function)

Specified by:

apply in interface XSTerm

apply

public <T,P> T apply(XSTermFunctionWithParam<T,P> function,
 P param)

Specified by:

apply in interface XSTerm

apply

public Object apply(XSFunction function)

Description copied from interface: XSComponent

Accepts a functor.

Specified by:

apply in interface XSComponent

getTerm

public XSTerm getTerm()

Description copied from interface: Ref.Term

Obtains a reference as a term.

Specified by:

getTerm in interface Ref.Term