net.sf.saxon.om
Class VirtualDocumentCopy

java.lang.Object
  net.sf.saxon.om.VirtualCopy
      net.sf.saxon.om.VirtualDocumentCopy

All Implemented Interfaces:

Source, SourceLocator, PullEvent, DocumentInfo, Item, NodeInfo, ValueRepresentation

public class VirtualDocumentCopy
extends VirtualCopy
implements DocumentInfo

A virtual copy of a document node

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.saxon.om.VirtualCopy

VirtualCopy.VirtualCopier

Field Summary

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

documentNumber, original, parent, root, systemId

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 interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Constructor Summary

VirtualDocumentCopy(DocumentInfo base)

Method Summary

String[]	getUnparsedEntity(String name) Get the unparsed entity with a given name
Iterator<String>	getUnparsedEntityNames() Get the list of unparsed entities defined in this document
NodeInfo	selectID(String id, boolean getParent) Get the element with a given ID, if any

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

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeKind, getParent, getPrefix, getPublicId, getRoot, getStringValue, getStringValueCS, getSystemId, getTypeAnnotation, getTypedValue, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis, makeCopier, makeVirtualCopy, setDocumentNumber, setSystemId, wrap

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

atomize, compareOrder, copy, equals, generateId, getAttributeValue, getBaseURI, getColumnNumber, getConfiguration, getDeclaredNamespaces, getDisplayName, getDocumentNumber, getDocumentRoot, getFingerprint, getLineNumber, getLocalPart, getNameCode, getNamePool, getNodeKind, getParent, getPrefix, getRoot, getStringValue, getSystemId, getTypeAnnotation, getURI, hasChildNodes, hashCode, isId, isIdref, isNilled, isSameNodeInfo, iterateAxis, iterateAxis

Methods inherited from interface javax.xml.transform.Source

setSystemId

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

getStringValueCS, getTypedValue

Constructor Detail

VirtualDocumentCopy

public VirtualDocumentCopy(DocumentInfo base)

Method Detail

selectID

public NodeInfo selectID(String id,
                         boolean getParent)

Get the element with a given ID, if any

Specified by:

selectID in interface DocumentInfo

Parameters:

id - the required ID value

getParent -

Returns:

the element with the given ID, or null if there is no such ID present (or if the parser has not notified attributes as being of type ID)

getUnparsedEntityNames

public Iterator<String> 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 String[] getUnparsedEntity(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, return null.