MSV Core 2022.7 · com.sun.msv.grammar.xmlschema.ComplexTypeExp

ComplexType definition. ComplexTypeExp holds an expression (as a ReferenceExp) that matches to this type itself.

the body field contains the expression that exactly matches to the declared content model (without any substitutable types).

the exp field contains the reference to the body field, if this complex type is not abstract. If abstract, then nullSet is set. You shouldn't directly manipulate the exp field. Instead, you should use the setAbstract(boolean) method to do it.

Note

The runtime type substitution (the use of xsi:type attribute) is implemented at the VGM layer. Therefore, AGMs of XML Schema does NOT precisely represent what are actually allowed and what are not.

Complex Type Definition Schema Component Properties

This table shows the mapping between "complex type definition schema component properties" (which is defined in the spec) and corresponding method/field of this class.

Property of the spec	method/field of this class
name	The `name` field.
target namespace	the `getTargetNamespace()` method.
abstract	the `isAbstract()` method.
base type definition	`simpleBaseType` or `complexBaseType` field, depending on whether the base type is a simple type or a complex type.
derivation method	the `derivationMethod` field.
final	the `finalValue` field.
prohibited substitutions	the `block` field.
attribtue uses attribute wildcard content type	Not directly accessible. Can be found by walking the children of the `body` field.
annotation	Unaccessible. This information is removed during the parsing phase.

Abstractness

The exp field and the self field are very similar. In fact, the only difference is that the former is affected by the abstract property, while the latter isn't.

So if it has to be affected by the abstract property (like referencing a complex type as the element body), you should use the exp field. If you don't want to be affected by the abstract property (like referencing a complex type as the base type of another complex type), then you should refer to the body field.

Field Summary

Modifier and Type	Field and Description
public final ReferenceExp	attWildcard attribute wildcard as an expression.
public int	block The block property of this schema component, implemented as a bit field.
public final ReferenceExp	body actual content model definition + attribute uses.
public ComplexTypeExp	complexBaseType base type of this complex type.
public int	derivationMethod the derivation method used to derive this complex type from the base type.
public int	finalValue The final property of this schema component, implemented as a bit field.
public final XMLSchemaSchema	parent parent XMLSchemaSchema object to which this object belongs.
private static final long	serialVersionUID Hides com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp.serialVersionUID.
public XSDatatypeExp	simpleBaseType base type of this complex type.
public AttributeWildcard	wildcard Attribute wild card constraint.

Inherited from com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp:: EXTENSION RESTRICTION

Constructor Summary

Access	Constructor and Description
public	ComplexTypeExp(XMLSchemaSchema schema, String localName)

Method Summary

Modifier and Type	Method and Description
public AttributeWildcard	getAttributeWildcard()
public int	getBlock() Implements abstract com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp.getBlock. Gets the value of the block constraint.
public RedefinableExp	getClone() Implements abstract com.sun.msv.grammar.xmlschema.RedefinableExp.getClone. clone this object.
public final String	getTargetNamespace() gets the target namespace property of this component as specified in the spec.
public boolean	Returns: true if this method is abstract. Flase if not. isAbstract() checks if this complex type is abstract.
public boolean	isDefined() Overrides com.sun.msv.grammar.ReferenceExp.isDefined. implementation detail.
public boolean	Returns: true if the specified type is "validly derived" from this type. false if not. isDerivedTypeOf(ComplexTypeExp baseType, int A bit field that represents the restricted derivation. This field must consists of bitwise and of `EXTENSION` or `RESTRICTION`. constraint) Checks if this type is a derived type of the specified type.
public boolean	isDerivedTypeOf(XSDatatype baseType, int constraint)
public boolean	isDerivedTypeOf(XMLSchemaTypeExp exp, int constraint)
public void	redefine(RedefinableExp _rhs) Overrides com.sun.msv.grammar.xmlschema.RedefinableExp.redefine. assigns contents of rhs to this object.
public void	setAbstract(boolean isAbstract)
public void	setAttributeWildcard(AttributeWildcard local)

Field Detail

attWildcard	back to summary
public final ReferenceExp attWildcard attribute wildcard as an expression.

block	back to summary
public int block The block property of this schema component, implemented as a bit field. 0, RESTRICTION, EXTENSION, or (RESTRICTION\|EXTENSION).

block

back to summary

public int block

The block property of this schema component, implemented as a bit field.

0, RESTRICTION, EXTENSION, or (RESTRICTION|EXTENSION).

body	back to summary
public final ReferenceExp body actual content model definition + attribute uses.

complexBaseType back to summary

complexBaseType	back to summary
public ComplexTypeExp complexBaseType base type of this complex type. Either baseComplexType field or baseSimpleType field is set. If the base type is ur-type, both fields are set to null. See Also `simpleBaseType`

public ComplexTypeExp complexBaseType

base type of this complex type. Either baseComplexType field or baseSimpleType field is set. If the base type is ur-type, both fields are set to null.

See Also: simpleBaseType

derivationMethod back to summary

derivationMethod	back to summary
public int derivationMethod the derivation method used to derive this complex type from the base type. Either RESTRICTION or EXTENSION. See Also `simpleBaseType`

public int derivationMethod

the derivation method used to derive this complex type from the base type. Either RESTRICTION or EXTENSION.

See Also: simpleBaseType

finalValue	back to summary
public int finalValue The final property of this schema component, implemented as a bit field. 0, RESTRICTION, EXTENSION, or (RESTRICTION\|EXTENSION).

finalValue

back to summary

public int finalValue

The final property of this schema component, implemented as a bit field.

0, RESTRICTION, EXTENSION, or (RESTRICTION|EXTENSION).

parent	back to summary
public final XMLSchemaSchema parent parent XMLSchemaSchema object to which this object belongs.

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp.serialVersionUID.

simpleBaseType back to summary

simpleBaseType	back to summary
public XSDatatypeExp simpleBaseType base type of this complex type. See Also `complexBaseType`

public XSDatatypeExp simpleBaseType

base type of this complex type.

See Also: complexBaseType

wildcard	back to summary
public AttributeWildcard wildcard Attribute wild card constraint. Due to the nasty definition of the interaction between attribute wildcards, we cannot add the expression for validating wildcard until the very last moment. Until the wrap-up phase of the schema parsing, this field will contain the "local wildcard definition." In the wrap-up phase, this field is replaced by the "complete wildcard definition."

wildcard

back to summary

public AttributeWildcard wildcard

Attribute wild card constraint.

Due to the nasty definition of the interaction between attribute wildcards, we cannot add the expression for validating wildcard until the very last moment.

Until the wrap-up phase of the schema parsing, this field will contain the "local wildcard definition." In the wrap-up phase, this field is replaced by the "complete wildcard definition."

Constructor Detail

ComplexTypeExp	back to summary
public ComplexTypeExp(XMLSchemaSchema schema, String localName)

Method Detail

getAttributeWildcard	back to summary
public AttributeWildcard getAttributeWildcard()

getBlock	back to summary
public int getBlock() Implements abstract com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp.getBlock. Gets the value of the block constraint. SimpleTypeExp always returns 0 because it doesn't have the block constraint.

getBlock

back to summary

public int getBlock()

Implements abstract com.sun.msv.grammar.xmlschema.XMLSchemaTypeExp.getBlock.

Gets the value of the block constraint. SimpleTypeExp always returns 0 because it doesn't have the block constraint.

getClone	back to summary
public RedefinableExp getClone() Implements abstract com.sun.msv.grammar.xmlschema.RedefinableExp.getClone. clone this object.

getClone

back to summary

public RedefinableExp getClone()

Implements abstract com.sun.msv.grammar.xmlschema.RedefinableExp.getClone.

clone this object.

getTargetNamespace back to summary

getTargetNamespace	back to summary
public final String getTargetNamespace() gets the target namespace property of this component as specified in the spec. If the property is absent, then this method returns the empty string. This method is just a shortcut for `parent.targetNamespace`.

public final String getTargetNamespace()

gets the target namespace property of this component as specified in the spec.

If the property is absent, then this method returns the empty string.

This method is just a shortcut for parent.targetNamespace.

isAbstract	back to summary
public boolean isAbstract() checks if this complex type is abstract. This method corresponds to the abstract property of the complex type declaration schema component. Returns:boolean true if this method is abstract. Flase if not.

isAbstract

back to summary

public boolean isAbstract()

checks if this complex type is abstract.

This method corresponds to the abstract property of the complex type declaration schema component.

Returns:boolean: true if this method is abstract. Flase if not.

isDefined	back to summary
public boolean isDefined() Overrides com.sun.msv.grammar.ReferenceExp.isDefined. implementation detail. A ComplexTypeDecl is properly defined if its self is defined. Note that the default implementation of the isDefined method doesn't work for this class because the exp field is set by the constructor.

isDefined

back to summary

public boolean isDefined()

Overrides com.sun.msv.grammar.ReferenceExp.isDefined.

implementation detail. A ComplexTypeDecl is properly defined if its self is defined. Note that the default implementation of the isDefined method doesn't work for this class because the exp field is set by the constructor.

isDerivedTypeOf back to summary

isDerivedTypeOf	back to summary
public boolean isDerivedTypeOf(ComplexTypeExp baseType, int constraint) Checks if this type is a derived type of the specified type. This method is an implementation of "Type Derivation OK (Complex)" test of the spec. If you are not familiar with the abovementioned part of the spec, don't use this method. This method probably won't give you what you expected. Parameters constraint:int A bit field that represents the restricted derivation. This field must consists of bitwise and of `EXTENSION` or `RESTRICTION`. Returns:boolean true if the specified type is "validly derived" from this type. false if not.

public boolean isDerivedTypeOf(ComplexTypeExp baseType, int constraint)

Checks if this type is a derived type of the specified type.

This method is an implementation of "Type Derivation OK (Complex)" test of the spec.

If you are not familiar with the abovementioned part of the spec, don't use this method. This method probably won't give you what you expected.

Parameters

constraint:int: A bit field that represents the restricted derivation. This field must consists of bitwise and of EXTENSION or RESTRICTION.

Returns:boolean

true if the specified type is "validly derived" from this type. false if not.

isDerivedTypeOf	back to summary
public boolean isDerivedTypeOf(XSDatatype baseType, int constraint) See Also `isDerivedTypeOf(ComplexTypeExp, int)`

isDerivedTypeOf	back to summary
public boolean isDerivedTypeOf(XMLSchemaTypeExp exp, int constraint)

redefine	back to summary
public void redefine(RedefinableExp _rhs) Overrides com.sun.msv.grammar.xmlschema.RedefinableExp.redefine. Doc from com.sun.msv.grammar.xmlschema.RedefinableExp.redefine. assigns contents of rhs to this object. rhs and this object must be the same runtime type, and they must have the same name. this method redefines this object by the given component. derived class should override this method and copy necessary fields, should it necessary.

redefine

back to summary

public void redefine(RedefinableExp _rhs)

Overrides com.sun.msv.grammar.xmlschema.RedefinableExp.redefine.

Doc from com.sun.msv.grammar.xmlschema.RedefinableExp.redefine.

assigns contents of rhs to this object. rhs and this object must be the same runtime type, and they must have the same name. this method redefines this object by the given component. derived class should override this method and copy necessary fields, should it necessary.

setAbstract	back to summary
public void setAbstract(boolean isAbstract)

setAttributeWildcard	back to summary
public void setAttributeWildcard(AttributeWildcard local)

public Class ComplexTypeExp

Complex Type Definition Schema Component Properties

Abstractness

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail