Package net.sf.saxon.tree.wrapper
Class SpaceStrippedDocument
- java.lang.Object
-
- net.sf.saxon.tree.wrapper.AbstractVirtualNode
-
- net.sf.saxon.tree.wrapper.SpaceStrippedNode
-
- net.sf.saxon.tree.wrapper.SpaceStrippedDocument
-
- All Implemented Interfaces:
javax.xml.transform.Source
,PullEvent
,DocumentInfo
,Item<NodeInfo>
,NodeInfo
,ValueRepresentation<NodeInfo>
,VirtualNode
,WrappingFunction
public class SpaceStrippedDocument extends SpaceStrippedNode implements DocumentInfo
A SpaceStrippedDocument represents a view of a real Document in which selected whitespace text nodes are treated as having been stripped.
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode
docWrapper, node, parent
-
Fields inherited from interface net.sf.saxon.om.NodeInfo
ALL_NAMESPACES, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description SpaceStrippedDocument(DocumentInfo doc, SpaceStrippingRule strippingRule)
Create a space-stripped view of a document
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsPreserveSpace()
Does the stripped document contain any xml:space="preserve" attributes?Configuration
getConfiguration()
Get the configuration previously set using setConfigurationlong
getDocumentNumber()
Get the unique document numberNamePool
getNamePool()
Get the name pool used for the names in this documentSpaceStrippingRule
getStrippingRule()
Get the document's strippingRulejava.lang.String[]
getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given namejava.util.Iterator<java.lang.String>
getUnparsedEntityNames()
Get the list of unparsed entities defined in this documentjava.lang.Object
getUserData(java.lang.String key)
Get user data held in the document node.boolean
isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPEDNodeInfo
selectID(java.lang.String id, boolean getParent)
Get the element with a given ID, if anyvoid
setUserData(java.lang.String key, java.lang.Object value)
Set user data on the document node.SpaceStrippedNode
wrap(NodeInfo node)
Create a wrapped node within this document-
Methods inherited from class net.sf.saxon.tree.wrapper.SpaceStrippedNode
atomize, compareOrder, copy, getParent, getStringValueCS, isSameNodeInfo, iterateAxis, makeWrapper, makeWrapper
-
Methods inherited from class net.sf.saxon.tree.wrapper.AbstractVirtualNode
equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getPrefix, getRealNode, getRoot, getSchemaType, getStringValue, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, iterateAxis, setSystemId
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.Item
getStringValueCS, getTypedValue
-
Methods inherited from interface net.sf.saxon.om.NodeInfo
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getSchemaType, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis
-
-
-
-
Constructor Detail
-
SpaceStrippedDocument
public SpaceStrippedDocument(DocumentInfo doc, SpaceStrippingRule strippingRule)
Create a space-stripped view of a document- Parameters:
doc
- the underlying documentstrippingRule
- an object that contains the rules defining which whitespace text nodes are to be absent from the view
-
-
Method Detail
-
wrap
public SpaceStrippedNode wrap(NodeInfo node)
Create a wrapped node within this document
-
isTyped
public boolean isTyped()
Ask whether the document contains any nodes whose type annotation is anything other than UNTYPED- Specified by:
isTyped
in interfaceDocumentInfo
- Returns:
- true if the document contains elements whose type is other than UNTYPED
-
getStrippingRule
public SpaceStrippingRule getStrippingRule()
Get the document's strippingRule
-
getConfiguration
public Configuration getConfiguration()
Get the configuration previously set using setConfiguration- Specified by:
getConfiguration
in interfaceNodeInfo
- Overrides:
getConfiguration
in classAbstractVirtualNode
- Returns:
- the Configuration
-
getNamePool
public NamePool getNamePool()
Get the name pool used for the names in this document- Specified by:
getNamePool
in interfaceNodeInfo
- Overrides:
getNamePool
in classAbstractVirtualNode
- Returns:
- the NamePool
-
getDocumentNumber
public long getDocumentNumber()
Get the unique document number- Specified by:
getDocumentNumber
in interfaceNodeInfo
- Overrides:
getDocumentNumber
in classAbstractVirtualNode
- Returns:
- the document number of the document containing this node
-
selectID
public NodeInfo selectID(java.lang.String id, boolean getParent)
Get the element with a given ID, if any- Specified by:
selectID
in interfaceDocumentInfo
- Parameters:
id
- the required ID valuegetParent
-- Returns:
- the element with the given ID value, or null if there is none.
-
getUnparsedEntityNames
public java.util.Iterator<java.lang.String> getUnparsedEntityNames()
Get the list of unparsed entities defined in this document- Specified by:
getUnparsedEntityNames
in interfaceDocumentInfo
- Returns:
- an Iterator, whose items are of type String, containing the names of all unparsed entities defined in this document. If there are no unparsed entities or if the information is not available then an empty iterator is returned
-
getUnparsedEntity
public java.lang.String[] getUnparsedEntity(java.lang.String name)
Get the unparsed entity with a given name- Specified by:
getUnparsedEntity
in interfaceDocumentInfo
- Parameters:
name
- the name of the entity- Returns:
- if the entity exists, return an array of two Strings, the first holding the system ID of the entity (as an absolute URI if possible), the second holding the public ID if there is one, or null if not. If the entity does not exist, the method returns null. Applications should be written on the assumption that this array may be extended in the future to provide additional information.
-
containsPreserveSpace
public boolean containsPreserveSpace()
Does the stripped document contain any xml:space="preserve" attributes?- Returns:
- true if any element in the document has an xml:space attribute with the value "preserve"
-
setUserData
public void setUserData(java.lang.String key, java.lang.Object value)
Set user data on the document node. The user data can be retrieved subsequently usinggetUserData(java.lang.String)
- Specified by:
setUserData
in interfaceDocumentInfo
- Parameters:
key
- A string giving the name of the property to be set. Clients are responsible for choosing a key that is likely to be unique. Must not be null. Keys used internally by Saxon are prefixed "saxon:".value
- The value to be set for the property. May be null, which effectively removes the existing value for the property.
-
getUserData
public java.lang.Object getUserData(java.lang.String key)
Get user data held in the document node. This retrieves properties previously set usingsetUserData(java.lang.String, java.lang.Object)
- Specified by:
getUserData
in interfaceDocumentInfo
- Parameters:
key
- A string giving the name of the property to be retrieved.- Returns:
- the value of the property, or null if the property has not been defined.
-
-