org.apache.xerces.dom3.as

Interface ASElementDeclaration

All Superinterfaces:
ASObject

public interface ASElementDeclaration
extends ASObject

Field Summary

static short
ANY_CONTENTTYPE
Represents an ANY content type for an Element declaration.
static short
ELEMENTS_CONTENTTYPE
Represents an ELEMENTS only content type for an Element declaration.
static short
EMPTY_CONTENTTYPE
Represents an EMPTY content type for an Element declaration.
static short
MIXED_CONTENTTYPE
Represents a MIXED content type for an Element declaration.

Fields inherited from interface org.apache.xerces.dom3.as.ASObject

AS_ATTRIBUTE_DECLARATION, AS_CONTENTMODEL, AS_ELEMENT_DECLARATION, AS_ENTITY_DECLARATION, AS_MODEL, AS_NOTATION_DECLARATION

Method Summary

void
addASAttributeDecl(ASAttributeDeclaration attributeDecl)
Adds an ASAttributeDeclaration for the element being declared.
ASNamedObjectMap
getASAttributeDecls()
TheASNamedObjectMap containing ASAttributeDeclarations for all the attributes that can appear on this type of element.
ASContentModel
getAsCM()
The content model of element.
short
getContentType()
The content type of the element.
ASDataType
getElementType()
Datatype of the element.
boolean
getIsPCDataOnly()
Boolean defining whether the element type contains child elements and PCDATA or PCDATA only for mixed element types.
boolean
getStrictMixedContent()
A boolean defining whether the element order and number of the child elements for mixed content type has to be respected or not.
String
getSystemId()
the URI reference representing the system identifier for the notation declaration, if present, null otherwise.
ASAttributeDeclaration
removeASAttributeDecl(ASAttributeDeclaration attributeDecl)
Removes an ASAttributeDeclaration from the element being declared.
void
setASAttributeDecls(ASNamedObjectMap ASAttributeDecls)
TheASNamedObjectMap containing ASAttributeDeclarations for all the attributes that can appear on this type of element.
void
setAsCM(ASContentModel asCM)
The content model of element.
void
setContentType(short contentType)
The content type of the element.
void
setElementType(ASDataType elementType)
Datatype of the element.
void
setIsPCDataOnly(boolean isPCDataOnly)
Boolean defining whether the element type contains child elements and PCDATA or PCDATA only for mixed element types.
void
setStrictMixedContent(boolean strictMixedContent)
A boolean defining whether the element order and number of the child elements for mixed content type has to be respected or not.
void
setSystemId(String systemId)
the URI reference representing the system identifier for the notation declaration, if present, null otherwise.

Methods inherited from interface org.apache.xerces.dom3.as.ASObject

cloneASObject, getAsNodeType, getLocalName, getNamespaceURI, getNodeName, getOwnerASModel, getPrefix, setLocalName, setNamespaceURI, setNodeName, setOwnerASModel, setPrefix

Field Details

ANY_CONTENTTYPE

public static final short ANY_CONTENTTYPE
Represents an ANY content type for an Element declaration.
Field Value:
2

ELEMENTS_CONTENTTYPE

public static final short ELEMENTS_CONTENTTYPE
Represents an ELEMENTS only content type for an Element declaration.
Field Value:
4

EMPTY_CONTENTTYPE

public static final short EMPTY_CONTENTTYPE
Represents an EMPTY content type for an Element declaration.
Field Value:
1

MIXED_CONTENTTYPE

public static final short MIXED_CONTENTTYPE
Represents a MIXED content type for an Element declaration. Note that isPCDataOnly would also need to checked, in addition to this, if an element's content model was simply text, as an example.
Field Value:
3

Method Details

addASAttributeDecl

public void addASAttributeDecl(ASAttributeDeclaration attributeDecl)
Adds an ASAttributeDeclaration for the element being declared.
Parameters:
attributeDecl - The new attribute to add. If the attribute declaration already exists for the element, the call does not have any effect.

getASAttributeDecls

public ASNamedObjectMap getASAttributeDecls()
TheASNamedObjectMap containing ASAttributeDeclarations for all the attributes that can appear on this type of element.

getAsCM

public ASContentModel getAsCM()
The content model of element.

getContentType

public short getContentType()
The content type of the element. One of EMPTY_CONTENTTYPE, ANY_CONTENTTYPE, MIXED_CONTENTTYPE, ELEMENTS_CONTENTTYPE.

getElementType

public ASDataType getElementType()
Datatype of the element.

getIsPCDataOnly

public boolean getIsPCDataOnly()
Boolean defining whether the element type contains child elements and PCDATA or PCDATA only for mixed element types. true if the element is of type PCDATA only. Relevant only for mixed content type elements.

getStrictMixedContent

public boolean getStrictMixedContent()
A boolean defining whether the element order and number of the child elements for mixed content type has to be respected or not. For example XML Schema defined mixed content types the order is important and needs to be respected whether for DTD based AS the order and number of child elements are not important.

getSystemId

public String getSystemId()
the URI reference representing the system identifier for the notation declaration, if present, null otherwise.

removeASAttributeDecl

public ASAttributeDeclaration removeASAttributeDecl(ASAttributeDeclaration attributeDecl)
Removes an ASAttributeDeclaration from the element being declared.
Parameters:
attributeDecl - The attribute declaraition to be removed. If the attribute declaration does not exist for the element, the call does not have any effect.
Returns:
null if the attribute does not exist. Otherwise returns the attribute being removed.

setASAttributeDecls

public void setASAttributeDecls(ASNamedObjectMap ASAttributeDecls)
TheASNamedObjectMap containing ASAttributeDeclarations for all the attributes that can appear on this type of element.

setAsCM

public void setAsCM(ASContentModel asCM)
The content model of element.

setContentType

public void setContentType(short contentType)
The content type of the element. One of EMPTY_CONTENTTYPE, ANY_CONTENTTYPE, MIXED_CONTENTTYPE, ELEMENTS_CONTENTTYPE.

setElementType

public void setElementType(ASDataType elementType)
Datatype of the element.

setIsPCDataOnly

public void setIsPCDataOnly(boolean isPCDataOnly)
Boolean defining whether the element type contains child elements and PCDATA or PCDATA only for mixed element types. true if the element is of type PCDATA only. Relevant only for mixed content type elements.

setStrictMixedContent

public void setStrictMixedContent(boolean strictMixedContent)
A boolean defining whether the element order and number of the child elements for mixed content type has to be respected or not. For example XML Schema defined mixed content types the order is important and needs to be respected whether for DTD based AS the order and number of child elements are not important.

setSystemId

public void setSystemId(String systemId)
the URI reference representing the system identifier for the notation declaration, if present, null otherwise.

Copyright © 1999-2004 Apache XML Project. All Rights Reserved.