Package net.sf.saxon.event
Class CheckSumFilter
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- net.sf.saxon.event.ProxyReceiver
-
- net.sf.saxon.event.CheckSumFilter
-
- All Implemented Interfaces:
javax.xml.transform.Result,Receiver
public class CheckSumFilter extends ProxyReceiver
A filter to go on a Receiver pipeline and calculate a checksum of the data passing through the pipeline. Optionally the filter will also check any checksum (represented by a processing instruction with name SIGMA) found in the file.The checksum takes account of element, attribute, and text nodes only. The order of attributes within an element makes no difference.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringSIGMA-
Fields inherited from class net.sf.saxon.event.ProxyReceiver
nextReceiver
-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description CheckSumFilter(Receiver nextReceiver)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item, Location locationId, int copyNamespaces)Append an arbitrary item (node or atomic value) to the outputvoidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidendElement()End of elementintgetChecksum()Get the accumulated checksumbooleanisChecksumCorrect()Ask if a correct checksum has been found in the filebooleanisChecksumFound()Ask whether a checksum has been foundvoidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidsetCheckExistingChecksum(boolean check)Ask the filter to check any existing checksums found in the filevoidstartDocument(int properties)Start of a document node.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an element-
Methods inherited from class net.sf.saxon.event.ProxyReceiver
close, comment, endDocument, getNamePool, getNextReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, usesTypeAnnotations
-
Methods inherited from class net.sf.saxon.event.SequenceReceiver
append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend
-
-
-
-
Field Detail
-
SIGMA
public static final java.lang.String SIGMA
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CheckSumFilter
public CheckSumFilter(Receiver nextReceiver)
-
-
Method Detail
-
setCheckExistingChecksum
public void setCheckExistingChecksum(boolean check)
Ask the filter to check any existing checksums found in the file- Parameters:
check- true if existing checksums are to be checked
-
startDocument
public void startDocument(int properties) throws XPathExceptionDescription copied from class:ProxyReceiverStart of a document node.- Specified by:
startDocumentin interfaceReceiver- Overrides:
startDocumentin classProxyReceiver- 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
-
append
public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
Append an arbitrary item (node or atomic value) to the output- Specified by:
appendin interfaceReceiver- Overrides:
appendin classProxyReceiver- Parameters:
item- the item to be appendedlocationId- the location of the calling instruction, for diagnosticscopyNamespaces- if the item is an element node, this indicates whether its namespaces need to be copied. Values areReceiverOption.ALL_NAMESPACES; the default (0) means- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionCharacter data- Specified by:
charactersin interfaceReceiver- Overrides:
charactersin classProxyReceiver- Parameters:
chars- The characterslocationId- 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
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Notify the start of an element- Specified by:
startElementin interfaceReceiver- Overrides:
startElementin classProxyReceiver- 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
-
endElement
public void endElement() throws XPathExceptionEnd of element- Specified by:
endElementin interfaceReceiver- Overrides:
endElementin classProxyReceiver- Throws:
XPathException- if an error occurs
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathExceptionProcessing Instruction- Specified by:
processingInstructionin interfaceReceiver- Overrides:
processingInstructionin classProxyReceiver- Parameters:
target- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocationId- provides information such as line number and system ID.properties- Additional information about the PI.- Throws:
XPathException- if an error occurs
-
isChecksumFound
public boolean isChecksumFound()
Ask whether a checksum has been found- Returns:
- true if a checksum processing instruction has been found (whether or not the checksum was correct)
-
getChecksum
public int getChecksum()
Get the accumulated checksum- Returns:
- the checksum of the events passed through the filter so far.
-
isChecksumCorrect
public boolean isChecksumCorrect()
Ask if a correct checksum has been found in the file- Returns:
- true if a checksum has been found, if its value matches, and if no significant data has been encountered after the checksum
-
-