public class CheckSumFilter extends ProxyReceiver
The checksum takes account of element, attribute, and text nodes only. The order of attributes within an element makes no difference.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SIGMA |
nextReceiver
pipelineConfiguration, previousAtomic, systemId
Constructor and Description |
---|
CheckSumFilter(Receiver nextReceiver) |
Modifier and Type | Method and Description |
---|---|
void |
append(Item item,
Location locationId,
int copyNamespaces)
Append an arbitrary item (node or atomic value) to the output
|
void |
attribute(NodeName nameCode,
SimpleType typeCode,
java.lang.CharSequence value,
Location locationId,
int properties)
Notify an attribute.
|
void |
characters(java.lang.CharSequence chars,
Location locationId,
int properties)
Character data
|
void |
endElement()
End of element
|
int |
getChecksum()
Get the accumulated checksum
|
boolean |
isChecksumCorrect()
Ask if a correct checksum has been found in the file
|
boolean |
isChecksumFound()
Ask whether a checksum has been found
|
void |
processingInstruction(java.lang.String target,
java.lang.CharSequence data,
Location locationId,
int properties)
Processing Instruction
|
void |
setCheckExistingChecksum(boolean check)
Ask the filter to check any existing checksums found in the file
|
void |
startDocument(int properties)
Start of a document node.
|
void |
startElement(NodeName elemName,
SchemaType typeCode,
Location location,
int properties)
Notify the start of an element
|
close, comment, endDocument, getNamePool, getUnderlyingReceiver, namespace, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, usesTypeAnnotations
append, getConfiguration, getPipelineConfiguration, getSystemId, isTrueSequenceReceiver
public static final java.lang.String SIGMA
public CheckSumFilter(Receiver nextReceiver)
public void setCheckExistingChecksum(boolean check)
check
- true if existing checksums are to be checkedpublic void startDocument(int properties) throws XPathException
ProxyReceiver
startDocument
in interface Receiver
startDocument
in class ProxyReceiver
properties
- bit-significant integer indicating properties of the document node.
The definitions of the bits are in class ReceiverOptions
XPathException
- if an error occurspublic void append(Item item, Location locationId, int copyNamespaces) throws XPathException
append
in class ProxyReceiver
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 are NodeInfo.ALL_NAMESPACES
,
NodeInfo.LOCAL_NAMESPACES
, NodeInfo.NO_NAMESPACES
XPathException
- if the operation failspublic void attribute(NodeName nameCode, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) throws XPathException
attribute
in interface Receiver
attribute
in class ProxyReceiver
nameCode
- The name of the attribute, as held in the name pooltypeCode
- The type of the attribute, as held in the name poolvalue
- The attribute valuelocationId
- The location of the attributeproperties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathException
characters
in interface Receiver
characters
in class ProxyReceiver
chars
- The characterslocationId
- provides information such as line number and system ID.properties
- Bit significant value. The following bits are defined:
XPathException
- if an error occurspublic void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
startElement
in interface Receiver
startElement
in class ProxyReceiver
elemName
- integer code identifying the name of the element within the name pool.typeCode
- integer code identifying the element's type within the name pool.location
- location of the elementproperties
- properties of the element nodeXPathException
- if an error occurspublic void endElement() throws XPathException
endElement
in interface Receiver
endElement
in class ProxyReceiver
XPathException
- if an error occurspublic void processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) throws XPathException
processingInstruction
in interface Receiver
processingInstruction
in class ProxyReceiver
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.XPathException
- if an error occurspublic boolean isChecksumFound()
public int getChecksum()
public boolean isChecksumCorrect()
Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.