Package com.saxonica.ee.stream.feed
Class CopyOfFeed
- java.lang.Object
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class CopyOfFeed extends AbsorptionFeed
This class is used to construct a grounded copy of a streamed node, by capturing the events representing the streamed node as they are notified, and constructing the grounded copy from these events.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCopyOfFeed.AccumulatorCopier-
Nested classes/interfaces inherited from class com.saxonica.ee.stream.feed.AbsorptionFeed
AbsorptionFeed.PendingItem
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.event.Outputter
pipelineConfiguration, systemId
-
-
Constructor Summary
Constructors Constructor Description CopyOfFeed(WatchManager watchManager, ItemFeed result, XPathContext context)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidattribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties)Notify an attribute.voidcharacters(java.lang.CharSequence chars, Location location, int properties)Notify character data.voidclose()Finish evaluating the expression.voidcomment(java.lang.CharSequence content, Location location, int properties)Notify a comment.voiddynamicError(XPathException error)Report a dynamic error.voidendDocument()Notify the end of a document nodevoidendElement()Notify the end of an element.static TriggergetWatch(ItemFeed result, Pattern selection, WatchManager wm, XPathContext context)Create a Watch whose effect is to create copies of the selected (streamed) nodes and pass them to the supplied feedprotected AbsorptionFeed.PendingItemmakePendingItem(int sequenceNr, FleetingParentNode node)Create a pending item (appropriate to the subclass) containing the data needed to compute the result value for one node in the streamed input sequencevoidnamespace(java.lang.String prefix, java.lang.String namespaceUri, int properties)Notify a namespace binding.protected SequenceprocessGroundedItem(Item item)Process a grounded item in the input sequence: either a streamed leaf node such as an attribute or text node, or an atomic value, or a non-streamed element or document node injected into the sequence for example by use of the comma operator.voidprocessingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties)Output a processing instructionvoidsetCopyAccumulators(boolean copy)Say whether accumulators are to be copiedvoidsetCopyNamespaces(boolean copy)Say whether unused namespaces are to be copiedvoidsetUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID)Notify an unparsed entity URI.voidsetValidationOptions(int validation, SchemaType type)Set the options for schema validationvoidstartContent()Notify the start of the content, that is, the completion of all attributes and namespaces.voidstartDocument(int properties)Notify the start of a document nodevoidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element, supplying all attributes and namespacesvoidstartElement(NodeName elemName, SchemaType typeCode, Location location, int properties)Notify the start of an element-
Methods inherited from class com.saxonica.ee.stream.feed.AbsorptionFeed
append, endSelectedParentNode, setHasFailed, startSelectedParentNode
-
Methods inherited from class com.saxonica.ee.stream.feed.ItemFeed
append, getContext, getExpression, getResult, getTerminator, hasFailed, open, processItems, setExpression, setTerminator
-
Methods inherited from class net.sf.saxon.event.ProxyOutputter
getNextOutputter, open, setLocation, usesTypeAnnotations
-
Methods inherited from class net.sf.saxon.event.Outputter
getConfiguration, getPipelineConfiguration, getStringReceiver, getSystemId, namespaces, setPipelineConfiguration, setSystemId
-
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.event.Receiver
handlesAppend
-
-
-
-
Constructor Detail
-
CopyOfFeed
public CopyOfFeed(WatchManager watchManager, ItemFeed result, XPathContext context)
-
-
Method Detail
-
getWatch
public static Trigger getWatch(ItemFeed result, Pattern selection, WatchManager wm, XPathContext context)
Create a Watch whose effect is to create copies of the selected (streamed) nodes and pass them to the supplied feed- Parameters:
result- The feed to which the copied nodes should be suppliedselection- defines the nodes to be selectedwm- The WatchManager that will notify the selected nodescontext- the XPath evaluation context- Returns:
- the new Watch
-
close
public void close() throws XPathExceptionDescription copied from class:ItemFeedFinish evaluating the expression.- Specified by:
closein interfaceReceiver- Overrides:
closein classItemFeed- Throws:
XPathException- if a dynamic error occurs
-
setCopyNamespaces
public void setCopyNamespaces(boolean copy)
Say whether unused namespaces are to be copied- Parameters:
copy- true if unused namespace declarations should be copied to the result tree (this is the default
-
setCopyAccumulators
public void setCopyAccumulators(boolean copy)
Say whether accumulators are to be copied- Parameters:
copy- true if unused namespace declarations should be copied to the result tree (this is the default
-
setValidationOptions
public void setValidationOptions(int validation, SchemaType type)Set the options for schema validation- Parameters:
validation- the validation mode, e.g. strict, lax, preserve, striptype- the type to validate against
-
makePendingItem
protected AbsorptionFeed.PendingItem makePendingItem(int sequenceNr, FleetingParentNode node)
Description copied from class:AbsorptionFeedCreate a pending item (appropriate to the subclass) containing the data needed to compute the result value for one node in the streamed input sequence- Specified by:
makePendingItemin classAbsorptionFeed- Parameters:
sequenceNr- the sequence number of this node within a set of nested nodesnode- the streamed input node- Returns:
- the data needed to process this node
-
processGroundedItem
protected Sequence processGroundedItem(Item item) throws XPathException
Description copied from class:AbsorptionFeedProcess a grounded item in the input sequence: either a streamed leaf node such as an attribute or text node, or an atomic value, or a non-streamed element or document node injected into the sequence for example by use of the comma operator.- Specified by:
processGroundedItemin classAbsorptionFeed- Parameters:
item- the grounded item- Returns:
- the result of processing the grounded item
- Throws:
XPathException- if a dynamic error occurs
-
dynamicError
public void dynamicError(XPathException error) throws XPathException
Report a dynamic error. This requires searching up the "feed" pipeline to see if there is a try/catch expression interested in being notified of this error; if there is none, the error is thrown as an exception- Overrides:
dynamicErrorin classItemFeed- Parameters:
error- the exception representing the dynamic error- Throws:
XPathException- if there is no try/catch expression wanting to catch this error
-
startDocument
public void startDocument(int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify the start of a document node- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin classGroundedItemFeed- Parameters:
properties- bit-significant integer indicating properties of the document node. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionDescription copied from class:ProxyOutputterNotify the end of a document node- Specified by:
endDocumentin interfaceReceiver- Overrides:
endDocumentin classGroundedItemFeed- Throws:
XPathException- if an error occurs
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathExceptionDescription copied from class:ProxyOutputterNotify an unparsed entity URI.- Specified by:
setUnparsedEntityin interfaceReceiver- Overrides:
setUnparsedEntityin classGroundedItemFeed- Parameters:
name- The name of the unparsed entitysystemID- The system identifier of the unparsed entitypublicID- The identifier of the unparsed entity- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
Description copied from class:ProxyOutputterNotify the start of an element- Overrides:
startElementin classGroundedItemFeed- Parameters:
elemName- the name of the element.typeCode- the type annotation of the element.location- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
namespace
public void namespace(java.lang.String prefix, java.lang.String namespaceUri, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify a namespace binding. This method is called at some point after startElement(). The semantics are similar to the xsl:namespace instruction in XSLT, or the namespace node constructor in XQuery. A namespace must not conflict with any namespaces already used for element or attribute names.- Overrides:
namespacein classGroundedItemFeed- Parameters:
prefix- The namespace prefix; zero-length string for the default namespacenamespaceUri- The namespace URI. In some cases a zero-length string may be used to indicate a namespace undeclaration.properties- The REJECT_DUPLICATES property: if set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:- Throws:
XPathException- if an error occurs
-
attribute
public void attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location location, int properties) throws XPathException
Description copied from class:ProxyOutputterNotify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.- Overrides:
attributein classGroundedItemFeed- Parameters:
attName- The name of the attributetypeCode- The type annotation of the attributevalue- the string value of the attributelocation- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this attribute
- NO_SPECIAL_CHARACTERS
- Attribute value contains no special characters
- Throws:
XPathException- if an error occurs
-
startContent
public void startContent() throws XPathExceptionDescription copied from class:ProxyOutputterNotify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial Outputter of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.- Overrides:
startContentin classGroundedItemFeed- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionDescription copied from class:ProxyOutputterNotify the end of an element. The Outputter must maintain a stack if it needs to know which element is ending.- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classGroundedItemFeed- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location location, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin classGroundedItemFeed- Parameters:
chars- The characterslocation- provides information such as line number and system ID.properties- Bit significant value. The following bits are defined:- DISABLE_ESCAPING
- Disable escaping for this text node
- USE_CDATA
- Output as a CDATA section
- Throws:
XPathException- if an error occurs
-
processingInstruction
public void processingInstruction(java.lang.String name, java.lang.CharSequence data, Location location, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterOutput a processing instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin classGroundedItemFeed- Parameters:
name- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocation- provides information such as line number and system ID.properties- Additional information about the PI.- Throws:
XPathException- if an error occurs
-
comment
public void comment(java.lang.CharSequence content, Location location, int properties) throws XPathExceptionDescription copied from class:ProxyOutputterNotify a comment. Comments are only notified if they are outside the DTD.- Specified by:
commentin interfaceReceiver- Overrides:
commentin classGroundedItemFeed- Parameters:
content- The content of the commentlocation- provides information such as line number and system ID.properties- Additional information about the comment.- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Description copied from class:ProxyOutputterNotify the start of an element, supplying all attributes and namespaces- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin classGroundedItemFeed- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
-