Class AbstractNode
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.xpath.AbstractNode
-
- All Implemented Interfaces:
Source
,SourceLocator
,net.sf.saxon.lib.ActiveSource
,net.sf.saxon.om.GroundedValue
,net.sf.saxon.om.Item
,net.sf.saxon.om.NodeInfo
,net.sf.saxon.om.Sequence
,net.sf.saxon.s9api.Location
,Locator
- Direct Known Subclasses:
AbstractElementNode
,AbstractRootNode
,AttributeNode
public abstract class AbstractNode extends Object implements net.sf.saxon.om.NodeInfo
Represents general class forElementNode
,RootNode
andAttributeNode
.
-
-
Field Summary
Fields Modifier and Type Field Description private List<AbstractNode>
children
The children.private net.sf.saxon.om.TreeInfo
treeInfo
TheTreeInfo
object.
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractNode(net.sf.saxon.om.TreeInfo treeInfo)
Constructor of the abstract classAbstractNode
.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description net.sf.saxon.om.AtomicSequence
atomize()
Returns AtomicSequence.void
copy(net.sf.saxon.event.Receiver receiver, int index, net.sf.saxon.s9api.Location location)
Copy method.protected abstract List<AbstractNode>
createChildren()
Creates nodes for children.private static UnsupportedOperationException
createUnsupportedOperationException()
Returns UnsupportedOperationException exception.void
generateId(StringBuilder buffer)
Generate id method.net.sf.saxon.om.NamespaceMap
getAllNamespaces()
Returns namespace array.String
getBaseURI()
Returns base uri.protected List<AbstractNode>
getChildren()
Getter method for children.net.sf.saxon.Configuration
getConfiguration()
Returns configuration.net.sf.saxon.om.NamespaceBinding[]
getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] namespaceBindings)
Returns namespace array.abstract int
getDepth()
Getter method for node depth.String
getDisplayName()
Returns display name.int
getFingerprint()
Returns fingerprint.net.sf.saxon.om.NamespaceUri
getNamespaceUri()
Get the URI part of the name of this node.String
getPrefix()
Returns prefix.String
getPublicId()
Returns public id.net.sf.saxon.type.SchemaType
getSchemaType()
Returns type of the schema.String
getStringValue()
Returns string value.String
getSystemId()
Returns system id.abstract int
getTokenType()
Getter method for token type.net.sf.saxon.om.TreeInfo
getTreeInfo()
Returns tree info.abstract Object
getUnderlyingNode()
Returns underlying node.net.sf.saxon.str.UnicodeString
getUnicodeStringValue()
Returns the value of the item as a Unicode string.String
getURI()
Returns uri of the namespace for the current node.boolean
hasFingerprint()
Returns if implementation provides fingerprints.boolean
isId()
Returns boolean.boolean
isIdref()
Returns boolean.boolean
isNilled()
Returns boolean.boolean
isSameNodeInfo(net.sf.saxon.om.NodeInfo nodeInfo)
Returns true if nodes are same, false otherwise.boolean
isStreamed()
Returns boolean.net.sf.saxon.tree.iter.AxisIterator
iterateAxis(int axisNumber, net.sf.saxon.pattern.NodePredicate nodeTest)
Determines axis iteration algorithm.net.sf.saxon.s9api.Location
saveLocation()
Returns location.void
setSystemId(String systemId)
Sets system id.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, effectiveBooleanValue, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
getLength, head, itemAt, iterate, reduce, subsequence
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
asActiveSource, attributes, children, children, compareOrder, deliver, equals, getAttributeValue, getAttributeValue, getColumnNumber, getGenre, getLineNumber, getLocalPart, getNodeKind, getParent, getRoot, hasChildNodes, hashCode, iterateAxis, toShortString
-
-
-
-
Field Detail
-
treeInfo
private final net.sf.saxon.om.TreeInfo treeInfo
TheTreeInfo
object.
-
children
private List<AbstractNode> children
The children.
-
-
Constructor Detail
-
AbstractNode
protected AbstractNode(net.sf.saxon.om.TreeInfo treeInfo)
Constructor of the abstract classAbstractNode
.- Parameters:
treeInfo
-TreeInfo
object
-
-
Method Detail
-
getTokenType
public abstract int getTokenType()
Getter method for token type.- Returns:
- token type
-
getUnderlyingNode
public abstract Object getUnderlyingNode()
Returns underlying node.- Returns:
- underlying node
-
getDepth
public abstract int getDepth()
Getter method for node depth.- Returns:
- depth
-
createChildren
protected abstract List<AbstractNode> createChildren()
Creates nodes for children.- Returns:
- children list
-
getChildren
protected List<AbstractNode> getChildren()
Getter method for children.- Returns:
- children list
-
isSameNodeInfo
public boolean isSameNodeInfo(net.sf.saxon.om.NodeInfo nodeInfo)
Returns true if nodes are same, false otherwise.- Specified by:
isSameNodeInfo
in interfacenet.sf.saxon.om.NodeInfo
- Parameters:
nodeInfo
- other node- Returns:
TreeInfo
-
hasFingerprint
public boolean hasFingerprint()
Returns if implementation provides fingerprints.- Specified by:
hasFingerprint
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
boolean
-
getNamespaceUri
public net.sf.saxon.om.NamespaceUri getNamespaceUri()
Get the URI part of the name of this node.- Specified by:
getNamespaceUri
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- The URI of the namespace of this node.
-
getURI
public String getURI()
Returns uri of the namespace for the current node.- Specified by:
getURI
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- uri
-
iterateAxis
public net.sf.saxon.tree.iter.AxisIterator iterateAxis(int axisNumber, net.sf.saxon.pattern.NodePredicate nodeTest)
Determines axis iteration algorithm.- Specified by:
iterateAxis
in interfacenet.sf.saxon.om.NodeInfo
- Parameters:
axisNumber
- element fromAxisInfo
nodeTest
- filter for iterator- Returns:
AxisIterator
object
-
getTreeInfo
public final net.sf.saxon.om.TreeInfo getTreeInfo()
Returns tree info.- Specified by:
getTreeInfo
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- tree info
-
getStringValue
public String getStringValue()
Returns string value. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getStringValue
in interfacenet.sf.saxon.om.GroundedValue
- Specified by:
getStringValue
in interfacenet.sf.saxon.om.Item
- Returns:
- string value
-
getDeclaredNamespaces
public final net.sf.saxon.om.NamespaceBinding[] getDeclaredNamespaces(net.sf.saxon.om.NamespaceBinding[] namespaceBindings)
Returns namespace array. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getDeclaredNamespaces
in interfacenet.sf.saxon.om.NodeInfo
- Parameters:
namespaceBindings
- namespace array- Returns:
- namespace array
-
getAllNamespaces
public net.sf.saxon.om.NamespaceMap getAllNamespaces()
Returns namespace array. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getAllNamespaces
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- namespace map
-
isId
public final boolean isId()
Returns boolean. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
isId
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- boolean
-
isIdref
public final boolean isIdref()
Returns boolean. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
isIdref
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- boolean
-
isNilled
public final boolean isNilled()
Returns boolean. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
isNilled
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- boolean
-
isStreamed
public final boolean isStreamed()
Returns boolean. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
isStreamed
in interfacenet.sf.saxon.om.Item
- Specified by:
isStreamed
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- boolean
-
getConfiguration
public final net.sf.saxon.Configuration getConfiguration()
Returns configuration. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getConfiguration
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- configuration
-
setSystemId
public final void setSystemId(String systemId)
Sets system id. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
setSystemId
in interfacenet.sf.saxon.om.NodeInfo
- Specified by:
setSystemId
in interfaceSource
- Parameters:
systemId
- system id
-
getSystemId
public final String getSystemId()
Returns system id. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getSystemId
in interfacenet.sf.saxon.s9api.Location
- Specified by:
getSystemId
in interfaceLocator
- Specified by:
getSystemId
in interfacenet.sf.saxon.om.NodeInfo
- Specified by:
getSystemId
in interfaceSource
- Specified by:
getSystemId
in interfaceSourceLocator
- Returns:
- system id
-
getPublicId
public final String getPublicId()
Returns public id. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getPublicId
in interfacenet.sf.saxon.s9api.Location
- Specified by:
getPublicId
in interfaceLocator
- Specified by:
getPublicId
in interfacenet.sf.saxon.om.NodeInfo
- Specified by:
getPublicId
in interfaceSourceLocator
- Returns:
- public id
-
getBaseURI
public final String getBaseURI()
Returns base uri. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getBaseURI
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- base uri
-
saveLocation
public final net.sf.saxon.s9api.Location saveLocation()
Returns location. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
saveLocation
in interfacenet.sf.saxon.s9api.Location
- Returns:
- location
-
getUnicodeStringValue
public final net.sf.saxon.str.UnicodeString getUnicodeStringValue()
Returns the value of the item as a Unicode string. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getUnicodeStringValue
in interfacenet.sf.saxon.om.GroundedValue
- Specified by:
getUnicodeStringValue
in interfacenet.sf.saxon.om.Item
- Returns:
- CharSequence string value
-
getFingerprint
public final int getFingerprint()
Returns fingerprint. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getFingerprint
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- fingerprint
-
getDisplayName
public final String getDisplayName()
Returns display name. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getDisplayName
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- display name
-
getPrefix
public final String getPrefix()
Returns prefix. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getPrefix
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- prefix
-
getSchemaType
public final net.sf.saxon.type.SchemaType getSchemaType()
Returns type of the schema. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
getSchemaType
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- type of the schema
-
atomize
public final net.sf.saxon.om.AtomicSequence atomize()
Returns AtomicSequence. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
atomize
in interfacenet.sf.saxon.om.Item
- Specified by:
atomize
in interfacenet.sf.saxon.om.NodeInfo
- Returns:
- AtomicSequence
-
generateId
public final void generateId(StringBuilder buffer)
Generate id method. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
generateId
in interfacenet.sf.saxon.om.NodeInfo
- Parameters:
buffer
- buffer
-
copy
public final void copy(net.sf.saxon.event.Receiver receiver, int index, net.sf.saxon.s9api.Location location)
Copy method. ThrowsUnsupportedOperationException
, because no child class implements it and this method is not used for querying.- Specified by:
copy
in interfacenet.sf.saxon.om.NodeInfo
- Parameters:
receiver
- receiverindex
- indexlocation
- location
-
createUnsupportedOperationException
private static UnsupportedOperationException createUnsupportedOperationException()
Returns UnsupportedOperationException exception. Methods which throws this exception are not supported for all nodes.- Returns:
- UnsupportedOperationException exception
-
-