com.saxonica.sdoc
Class XSDAttributeGroup

java.lang.Object
  extended by net.sf.saxon.tree.NodeImpl
      extended by net.sf.saxon.tree.ElementImpl
          extended by com.saxonica.sdoc.SchemaElement
              extended by com.saxonica.sdoc.XSDAttributeGroup
All Implemented Interfaces:
Source, SourceLocator, PullEvent, FingerprintedNode, Item, MutableNodeInfo, NamespaceResolver, NodeInfo, SiblingCountingNode, ValueRepresentation

public class XSDAttributeGroup
extends SchemaElement

An xs:attributeGroup element in an XML Schema document


Field Summary
protected  Object children
           
protected  int sequence
           
 
Fields inherited from class com.saxonica.sdoc.SchemaElement
NAMESPACE_ANY, NAMESPACE_LOCAL, NAMESPACE_OTHER, NAMESPACE_TARGET, REQUIRE_NULL_NS, REQUIRE_TARGET_NS, USE_DEFAULT_NS, USE_DEFAULT_NS_WITHOUT_IMPORT
 
Fields inherited from class net.sf.saxon.tree.ElementImpl
attributeList, nameCode, namespaceList, typeCode
 
Fields inherited from class net.sf.saxon.tree.NodeImpl
index, NODE_LETTER, parent
 
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
 
Constructor Summary
XSDAttributeGroup()
          Creates a new AttributeGroup element
 
Method Summary
 void addChild(NodeImpl node, int index)
          Add a child node to this node.
 void compact(int size)
          Compact the space used by this node
protected  AxisIterator enumerateChildren(NodeTest test)
          Get an enumeration of the children of this node
 AttributeGroupDecl getAttributeGroupDecl()
          Returns the AttributeGroupDecl created by this AttributeGroup declaration.
 AttributeGroupReference getAttributeGroupReference()
          Return the AttributeGroupReference, if this is a reference
 NodeInfo getFirstChild()
          Get the first child node of the element
 NodeInfo getLastChild()
          Get the last child node of the element
protected  NodeImpl getNthChild(int n)
          Get the nth child node of the element (numbering from 0)
 int getNumberOfChildren()
          Determine how many children the node has
 AttributeGroupDecl getRedefinedAttributeGroup()
           
protected  long getSequenceNumber()
          Get the node sequence number (in document order).
 String getStringValue()
          Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
 CharSequence getStringValueCS()
          Get the value of the item as a CharSequence.
 boolean hasChildNodes()
          Determine if the node has any children.
 void insertChildren(NodeInfo[] source, boolean atStart, boolean inherit)
          Insert copies of a sequence of nodes as children of this node.
protected  void insertChildrenAt(NodeInfo[] source, int index, boolean inherit)
          Insert children before or after a given existing child
protected  boolean isFinalState(int state)
          For elements whose content model is parsed using a finite state machine, test whether a given state is a final state.
 boolean isReference()
          Is this an attribute group declaration or a reference?
 void postValidate(SchemaCompiler compiler)
          Additional processing after all the children of this element have been validated.
 void prepareAttributes()
          Validate and process the attributes on this element in the schema document
protected  void removeChild(NodeImpl child)
          Remove a given child
protected  void replaceChildrenAt(NodeInfo[] source, int index, boolean inherit)
          Replace child at a given index by new children
protected  void useChildrenArray(NodeImpl[] array)
          Supply an array to be used for the array of children.
 void validate(SchemaCompiler compiler)
          Validate this schema element, checking all document-level constraints
 
Methods inherited from class com.saxonica.sdoc.SchemaElement
allocateAnonymousTypeCode, allowAttributes, checkContentModel, checkMutuallyExclusiveAttributes, checkOnlyChildIsAnnotation, checkPermittedType, duplicate, duplicateElement, error, error, getContainingComplexType, getContainingSimpleType, getFingerprint, getNameCode, getSchema, getSchemaNodeFactory, getXSDSchema, illegalElement, indefiniteArticle, invalidAttributeValue, isTopLevel, makeNamespaceContext, missingAttribute, missingChildElement, mustBeFirstElement, mustBeLastElement, mustPrecede, mutuallyExclusive, mutuallyExclusiveAttributes, mutuallyExclusiveElementAndAttribute, parseFinalOrBlock, processAllAttributes, processAllowedNamespaces, processDisallowedNamespaces, processDisallowedQNames, processId, processMaxOccurs, processMinOccurs, requireAttribute, setSchemaNodeFactory, validateChildren, validateSubtree, warning
 
Methods inherited from class net.sf.saxon.tree.ElementImpl
addAttribute, addNamespace, copy, delete, fixupInsertedNamespaces, generateId, getAttributeList, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDocumentRoot, getInScopeNamespaceCodes, getLineNumber, getNameCode, getNodeKind, getPrefixForURI, getRoot, getSystemId, getTypeAnnotation, getURICodeForPrefix, getURICodeForPrefixCode, getURIForPrefix, initialise, isId, isNilled, iteratePrefixes, removeAttribute, removeTypeAnnotation, rename, replaceStringValue, setLineAndColumn, setLocation, setNameCode, setNamespaceDeclarations, setSystemId, setTypeAnnotation
 
Methods inherited from class net.sf.saxon.tree.NodeImpl
atomize, compareOrder, equals, getConfiguration, getDisplayName, getDocumentNumber, getFingerprint, getLocalPart, getNamePool, getNextInDocument, getNextSibling, getParent, getPhysicalRoot, getPrefix, getPreviousInDocument, getPreviousSibling, getPublicId, getSiblingPosition, getTypedValue, getURI, insertSiblings, isDeleted, isIdref, isSameNodeInfo, iterateAxis, iterateAxis, newBuilder, replace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.sf.saxon.om.NodeInfo
hashCode
 

Field Detail

children

protected Object children

sequence

protected int sequence
Constructor Detail

XSDAttributeGroup

public XSDAttributeGroup()
Creates a new AttributeGroup element

Method Detail

prepareAttributes

public void prepareAttributes()
                       throws SchemaException
Validate and process the attributes on this element in the schema document

Specified by:
prepareAttributes in class SchemaElement
Throws:
SchemaException - if any errors are found in the attributes

isReference

public boolean isReference()
Is this an attribute group declaration or a reference?


getAttributeGroupDecl

public AttributeGroupDecl getAttributeGroupDecl()
                                         throws SchemaException
Returns the AttributeGroupDecl created by this AttributeGroup declaration.

Returns:
the AttributeGroupDecl corresponding to this xs:attribute-group element if it is a global attribute group declaration; if it is an attribute group reference, return null.
Throws:
SchemaException

getAttributeGroupReference

public AttributeGroupReference getAttributeGroupReference()
                                                   throws SchemaException
Return the AttributeGroupReference, if this is a reference

Returns:
the AttributeGroupReference, or null if this is not a reference
Throws:
SchemaException

validate

public void validate(SchemaCompiler compiler)
              throws SchemaException
Validate this schema element, checking all document-level constraints

Overrides:
validate in class SchemaElement
Parameters:
compiler -
Throws:
SchemaException - if any XML representation constraints are violated

isFinalState

protected boolean isFinalState(int state)
Description copied from class: SchemaElement
For elements whose content model is parsed using a finite state machine, test whether a given state is a final state. The default implementation of this method is never used; it exists for the benefit of subclasses that do not use this mechanism

Overrides:
isFinalState in class SchemaElement
Parameters:
state - the state to be tested
Returns:
true if the given state is a final state

postValidate

public void postValidate(SchemaCompiler compiler)
                  throws SchemaException
Additional processing after all the children of this element have been validated.

Overrides:
postValidate in class SchemaElement
Parameters:
compiler -
Throws:
SchemaException - if errors are found

getRedefinedAttributeGroup

public AttributeGroupDecl getRedefinedAttributeGroup()

getSequenceNumber

protected final long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and document nodes) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. For nodes added by XQUery Update, the sequence number is -1L

Overrides:
getSequenceNumber in class NodeImpl
Returns:
the sequence number if there is one, or -1L otherwise.

hasChildNodes

public final boolean hasChildNodes()
Determine if the node has any children.

Specified by:
hasChildNodes in interface NodeInfo
Overrides:
hasChildNodes in class NodeImpl
Returns:
true if the node has any children, false if the node has no children.

getNumberOfChildren

public int getNumberOfChildren()
Determine how many children the node has

Returns:
the number of children of this parent node

enumerateChildren

protected final AxisIterator enumerateChildren(NodeTest test)
Get an enumeration of the children of this node

Parameters:
test - A NodeTest to be satisfied by the child nodes, or null if all child node are to be returned
Returns:
an iterator over the children of this node

getFirstChild

public final NodeInfo getFirstChild()
Get the first child node of the element

Overrides:
getFirstChild in class NodeImpl
Returns:
the first child node of the required type, or null if there are no children

getLastChild

public final NodeInfo getLastChild()
Get the last child node of the element

Overrides:
getLastChild in class NodeImpl
Returns:
the last child of the element, or null if there are no children

getNthChild

protected final NodeImpl getNthChild(int n)
Get the nth child node of the element (numbering from 0)

Parameters:
n - identifies the required child
Returns:
the last child of the element, or null if there is no n'th child

removeChild

protected void removeChild(NodeImpl child)
Remove a given child

Parameters:
child - the child to be removed

getStringValue

public String getStringValue()
Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.

Returns:
the accumulated character content of the element, including descendant elements.
See Also:
Item.getStringValueCS()

getStringValueCS

public CharSequence getStringValueCS()
Description copied from class: NodeImpl
Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.

Specified by:
getStringValueCS in interface Item
Specified by:
getStringValueCS in interface ValueRepresentation
Overrides:
getStringValueCS in class NodeImpl
Returns:
the string value of the item
See Also:
Item.getStringValue()

useChildrenArray

protected void useChildrenArray(NodeImpl[] array)
Supply an array to be used for the array of children. For system use only.

Parameters:
array - the array to be used

addChild

public void addChild(NodeImpl node,
                     int index)
Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.

Parameters:
node - the node to be added as a child of this node
index - the position where the child is to be added

insertChildren

public void insertChildren(NodeInfo[] source,
                           boolean atStart,
                           boolean inherit)
Insert copies of a sequence of nodes as children of this node.

This method takes no action unless the target node is a document node or element node. It also takes no action in respect of any supplied nodes that are not elements, text nodes, comments, or processing instructions.

The supplied nodes will be copied to form the new children. Adjacent text nodes will be merged, and zero-length text nodes removed.

Specified by:
insertChildren in interface MutableNodeInfo
Overrides:
insertChildren in class NodeImpl
Parameters:
source - the nodes to be inserted
atStart - true if the new nodes are to be inserted before existing children; false if they are
inherit - true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children

insertChildrenAt

protected void insertChildrenAt(NodeInfo[] source,
                                int index,
                                boolean inherit)
Insert children before or after a given existing child

Parameters:
source - the children to be inserted
index - the position before which they are to be inserted: 0 indicates insertion before the first child, 1 insertion before the second child, and so on.
inherit - true if the inserted nodes are to inherit the namespaces that are in-scope for their new parent; false if such namespaces should be undeclared on the children

replaceChildrenAt

protected void replaceChildrenAt(NodeInfo[] source,
                                 int index,
                                 boolean inherit)
Replace child at a given index by new children

Parameters:
source - the children to be inserted
index - the position at which they are to be inserted: 0 indicates replacement of the first child, replacement of the second child, and so on. The effect is undefined if index is out of range
inherit - set to true if the new child elements are to inherit the in-scope namespaces of their new parent
Throws:
IllegalArgumentException - if any of the replacement nodes is not an element, text, comment, or processing instruction node

compact

public void compact(int size)
Compact the space used by this node

Parameters:
size - the number of actual children


Copyright (c) Saxonica Limited. All rights reserved.