StrippedDocument

java.lang.Object
- net.sf.saxon.om.StrippedNode
- - net.sf.saxon.om.StrippedDocument

All Implemented Interfaces:

javax.xml.transform.Source, PullEvent, DocumentInfo, Item, NodeInfo, ValueRepresentation, VirtualNode
```
public class StrippedDocument
extends StrippedNode
implements DocumentInfo
```
A StrippedDocument represents a view of a real Document in which selected whitespace text nodes are treated as having been stripped.

Field Summary
- Fields inherited from interface net.sf.saxon.om.NodeInfo
  ALL_NAMESPACES, EMPTY_NAMESPACE_LIST, IS_DTD_TYPE, IS_NILLED, LOCAL_NAMESPACES, NO_NAMESPACES
- Fields inherited from class net.sf.saxon.om.StrippedNode
  docWrapper, node, parent
- Fields inherited from interface net.sf.saxon.om.ValueRepresentation
  EMPTY_VALUE_ARRAY

Constructor Summary

Constructors
Constructor Description

StrippedDocument(DocumentInfo doc, Stripper stripper)

Constructors
Constructor	Description
`StrippedDocument(DocumentInfo doc, Stripper stripper)`

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 setConfiguration
`int`	`getDocumentNumber()`	Get the unique document number
`NamePool`	`getNamePool()`	Get the name pool used for the names in this document
`Stripper`	`getStripper()`	Get the document's stripper
`java.lang.String[]`	`getUnparsedEntity(java.lang.String name)`	Get the unparsed entity with a given name
`java.util.Iterator`	`getUnparsedEntityNames()`	Get the list of unparsed entities defined in this document
`NodeInfo`	`selectID(java.lang.String id)`	Get the element with a given ID, if any
`StrippedNode`	`wrap(NodeInfo node)`	Create a wrapped node within this document

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, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.transform.Source
isEmpty, setSystemId

Methods inherited from class net.sf.saxon.om.StrippedNode
atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getDeclaredNamespaces, getDisplayName, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getUnderlyingNode, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, makeWrapper, setSystemId

- Constructor Detail
  - StrippedDocument
```
public StrippedDocument(DocumentInfo doc,
                        Stripper stripper)
```
- Method Detail
  - wrap
```
public StrippedNode wrap(NodeInfo node)
```
    Create a wrapped node within this document
  - getStripper
```
public Stripper getStripper()
```
    Get the document's stripper
  - getConfiguration
```
public Configuration getConfiguration()
```
    Get the configuration previously set using setConfiguration
    
    Specified by:
    
    getConfiguration in interface NodeInfo
    
    Overrides:
    
    getConfiguration in class StrippedNode
    
    Returns:
    
    the Configuration
  - getNamePool
```
public NamePool getNamePool()
```
    Get the name pool used for the names in this document
    
    Specified by:
    
    getNamePool in interface NodeInfo
    
    Overrides:
    
    getNamePool in class StrippedNode
    
    Returns:
    
    the NamePool
  - getDocumentNumber
```
public int getDocumentNumber()
```
    Get the unique document number
    
    Specified by:
    
    getDocumentNumber in interface NodeInfo
    
    Overrides:
    
    getDocumentNumber in class StrippedNode
    
    Returns:
    
    the document number of the document containing this node
  - selectID
```
public NodeInfo selectID(java.lang.String id)
```
    Get the element with a given ID, if any
    
    Specified by:
    
    selectID in interface DocumentInfo
    
    Parameters:
    
    id - the required ID value
    
    Returns:
    
    the element with the given ID value, or null if there is none.
  - getUnparsedEntityNames
```
public java.util.Iterator getUnparsedEntityNames()
```
    Get the list of unparsed entities defined in this document
    
    Specified by:
    
    getUnparsedEntityNames in interface DocumentInfo
    
    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 interface DocumentInfo
    
    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, 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?

Class StrippedDocument

Field Summary

Fields inherited from interface net.sf.saxon.om.NodeInfo

Fields inherited from class net.sf.saxon.om.StrippedNode

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

Constructor Summary

Method Summary

Methods inherited from interface net.sf.saxon.om.Item

Methods inherited from interface net.sf.saxon.om.NodeInfo

Methods inherited from class java.lang.Object

Methods inherited from interface javax.xml.transform.Source

Methods inherited from class net.sf.saxon.om.StrippedNode

Constructor Detail

StrippedDocument

Method Detail

wrap

getStripper

getConfiguration

getNamePool

getDocumentNumber

selectID

getUnparsedEntityNames

getUnparsedEntity

containsPreserveSpace