Index

B C F G O P R S T X 
All Classes|All Packages

B

ByteTrackingReader - Class in com.thirdpartylabs.xmlscalpel.io.reader
FilterReader that tracks byte progress as chars are read.
ByteTrackingReader(Reader) - Constructor for class com.thirdpartylabs.xmlscalpel.io.reader.ByteTrackingReader
Creates a new byte tracking filtered reader.

C

CollectionPopulatingXMLStreamProcessor - Class in com.thirdpartylabs.xmlscalpel.processor
Fill a Collection with Fragment objects as they are generated by the StreamingXMLReader
CollectionPopulatingXMLStreamProcessor(Collection<Fragment>) - Constructor for class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
 
com.thirdpartylabs.xmlscalpel.entity - package com.thirdpartylabs.xmlscalpel.entity
Classes that wrap data used by the API.
com.thirdpartylabs.xmlscalpel.io.reader - package com.thirdpartylabs.xmlscalpel.io.reader
Classes that read XML data at various levels.
com.thirdpartylabs.xmlscalpel.processor - package com.thirdpartylabs.xmlscalpel.processor
Classes that work in conjunction with the StreamingXMLReader to process elements extracted from an XML file.

F

Fragment - Class in com.thirdpartylabs.xmlscalpel.entity
Wrapper for a DocumentFragment and corresponding XMLByteLocation
Fragment(DocumentFragment, XMLByteLocation) - Constructor for class com.thirdpartylabs.xmlscalpel.entity.Fragment
 

G

getBareDocument() - Method in class com.thirdpartylabs.xmlscalpel.entity.OuterDocument
The XML Document containing only the document element
getByteOffsetForCharOffset(long) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.ByteTrackingReader
Return the byte offset for the provided char offset
getBytesRead() - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
 
getBytesRemaining() - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
 
getBytesTotal() - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
 
getCharacterEncodingScheme() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Returns the character encoding declared on the xml declaration Returns null if none was declared
getDocumentElementAttributeNamespaces() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
A map containing the namespace prefix to URI pairs from the document element
getDocumentElementAttributes() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
A map containing the attribute name-value pairs from the document element
getDocumentElementTagName() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
The local name of the document element tag
getDocumentFragment() - Method in class com.thirdpartylabs.xmlscalpel.entity.Fragment
 
getDocumentFragmentForXmlString(String) - Method in class com.thirdpartylabs.xmlscalpel.entity.OuterDocument
Returns a DocumentFragment from the provided XML that is bound with the namespaces from the original outer document.
getEmptyDocument() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
 
getEmptyDocument(File) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
 
getEncoding() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Return input encoding if known or null if unknown.
getIndex() - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
getLength() - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
getNumProcessed() - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
 
getOffset() - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
getOuterDocument() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
 
getOuterDocument(File) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
 
getPrefix() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Returns the prefix of the current event or null if the event does not have a prefix
getVersion() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Get the xml version declared on the xml declaration Returns null if none was declared
getXmlByteLocation() - Method in class com.thirdpartylabs.xmlscalpel.entity.Fragment
 

O

OuterDocument - Class in com.thirdpartylabs.xmlscalpel.entity
Wrapper for the empty document read by the StreamingXMLReader
OuterDocument(Document) - Constructor for class com.thirdpartylabs.xmlscalpel.entity.OuterDocument
 
OuterDocument(Document, String) - Constructor for class com.thirdpartylabs.xmlscalpel.entity.OuterDocument
 

P

process(Fragment) - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
Called by the StreamingXMLReader as each node is extracted from the file
process(Fragment) - Method in interface com.thirdpartylabs.xmlscalpel.processor.XMLStreamProcessor
Accept Fragment objects from the StreamingXMLReader.

R

RandomAccessXMLReader - Class in com.thirdpartylabs.xmlscalpel.io.reader
Fast retrieval of strings from a file by byte offset and length as defined by an XMLByteLocation object
RandomAccessXMLReader() - Constructor for class com.thirdpartylabs.xmlscalpel.io.reader.RandomAccessXMLReader
 
read() - Method in class com.thirdpartylabs.xmlscalpel.io.reader.ByteTrackingReader
Read a char and count the bytes
read(char[], int, int) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.ByteTrackingReader
Read and count the bytes in the chars that are read
read(File, XMLByteLocation) - Static method in class com.thirdpartylabs.xmlscalpel.io.reader.RandomAccessXMLReader
Get a String from the provided File using the offset and length from the XMLByteLocation, encoded with the provided charset
read(File, XMLByteLocation, String) - Static method in class com.thirdpartylabs.xmlscalpel.io.reader.RandomAccessXMLReader
Get a String from the provided File using the offset and length from the XMLByteLocation, encoded with the provided charset
read(File, XMLByteLocation, Charset) - Static method in class com.thirdpartylabs.xmlscalpel.io.reader.RandomAccessXMLReader
Get a String from the provided File using the offset and length from the XMLByteLocation, encoded with the provided charset
readFile(File, XMLStreamProcessor) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Read an XML file using the Woodstox streaming API and supply the XMLStreamProcessor with Fragment objects.
readFile(File, XMLStreamProcessor, List<String>) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
Read an XML file using the Woodstox streaming API and supply the XMLStreamProcessor with Fragment objects.

S

setBareDocument(Document) - Method in class com.thirdpartylabs.xmlscalpel.entity.OuterDocument
 
setByte(long) - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
setBytesTotal(long) - Method in class com.thirdpartylabs.xmlscalpel.processor.CollectionPopulatingXMLStreamProcessor
Called by the StreamingXMLReader when the reading starts
setBytesTotal(long) - Method in interface com.thirdpartylabs.xmlscalpel.processor.XMLStreamProcessor
StreamingXMLReader will set the total number of bytes in the file before it begins parsing the file.
setIndex(int) - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
setOffset(long) - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
skip(long) - Method in class com.thirdpartylabs.xmlscalpel.io.reader.ByteTrackingReader
We read and count the bytes in chars we're skipping over
StreamingXMLReader - Class in com.thirdpartylabs.xmlscalpel.io.reader
Streaming XML file reader that uses the Woodstox stream reader to extract top level XML nodes along with metadata describing their location in the XML file, and send them to an XMLStreamProcessor.
StreamingXMLReader() - Constructor for class com.thirdpartylabs.xmlscalpel.io.reader.StreamingXMLReader
 

T

toString() - Method in class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 

X

XMLByteLocation - Class in com.thirdpartylabs.xmlscalpel.entity
Defines the location in a file of a specific XML node.
XMLByteLocation(int, long, long) - Constructor for class com.thirdpartylabs.xmlscalpel.entity.XMLByteLocation
 
XMLStreamProcessor - Interface in com.thirdpartylabs.xmlscalpel.processor
XMLStreamProcessor instances are provided to StreamingXMLReader and will receive all of the Fragments generated by the reader.
B C F G O P R S T X 
All Classes|All Packages