Class SAXFilter

java.lang.Object

org.eclipse.rdf4j.rio.rdfxml.SAXFilter

All Implemented Interfaces:

ContentHandler

class SAXFilter
extends Object
implements ContentHandler

A filter on SAX events to make life easier on the RDF parser itself. This filter does things like combining a call to startElement() that is directly followed by a call to endElement() to a single call to emptyElement().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SAXFilter.ElementInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final StringBuilder	charBuf	StringBuilder used to collect text during parsing.
private SAXFilter.ElementInfo	deferredElement	Variable used to defer reporting of start tags.
private ParsedIRI	documentURI	The document's URI.
private final Stack<SAXFilter.ElementInfo>	elInfoStack	Stack of ElementInfo objects.
private boolean	inRDFContext	Flag indicating whether we're currently parsing RDF elements.
private Locator	locator	A Locator indicating a position in the text that is currently being parsed by the SAX parser.
private final Map<String,String>	newNamespaceMappings	New namespace mappings that have been reported for the next start tag by the SAX parser, but that are not yet assigned to an ElementInfo object.
private boolean	parseLiteralMode	Flag indicating whether we're currently parsing an XML literal.
private boolean	parseStandAloneDocuments	Flag indicating whether the parser parses stand-alone RDF documents.
private int	rdfContextStackHeight	The number of elements on the stack that are in the RDF context.
private final RDFXMLParser	rdfParser	The RDF parser to supply the filtered SAX events to.
private final List<String>	unknownPrefixesInXMLLiteral	The prefixes that were used in an XML literal, but that were not defined in it (but rather in the XML literal's context).
private final List<String>	xmlLiteralPrefixes	The prefixes that are defined in the XML literal itself (this in contrast to the namespaces from the XML literal's context).
private int	xmlLiteralStackHeight	The number of elements on the stack that are part of an XML literal.

Constructor Summary

Constructors

Constructor	Description
SAXFilter(RDFXMLParser rdfParser)

Method Summary

Modifier and Type	Method	Description
private void	appendAttribute(StringBuilder sb, String name, String value)
private void	appendEndTag(String qName)	Appends an end tag to charBuf.
private void	appendNamespaceDecl(StringBuilder sb, String prefix, String namespace)
private void	appendStartTag(String qName, Attributes attributes)	Appends a start tag to charBuf.
void	characters(char[] ch, int start, int length)
private void	checkAndCopyAttributes(Attributes attributes, SAXFilter.ElementInfo elInfo)
void	clear()
private ParsedIRI	createBaseURI(String uriString)
void	endDocument()
void	endElement(String namespaceURI, String localName, String qName)
void	endPrefixMapping(String prefix)
Locator	getLocator()
boolean	getParseStandAloneDocuments()
void	ignorableWhitespace(char[] ch, int start, int length)
private void	insertUsedContextPrefixes()	Inserts prefix mappings from an XML Literal's context for all prefixes that are used in the XML Literal and that are not defined in the XML Literal itself.
private SAXFilter.ElementInfo	peekStack()
void	processingInstruction(String target, String data)
private void	reportDeferredStartElement()
void	setDocumentLocator(Locator loc)
void	setDocumentURI(String documentURI)
void	setParseLiteralMode()
void	setParseStandAloneDocuments(boolean standAloneDocs)
void	skippedEntity(String name)
void	startDocument()
void	startElement(String namespaceURI, String localName, String qName, Attributes attributes)
void	startPrefixMapping(String prefix, String uri)

Methods inherited from class Object

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

Field Details

rdfParser

private final RDFXMLParser rdfParser

The RDF parser to supply the filtered SAX events to.

locator

private Locator locator

A Locator indicating a position in the text that is currently being parsed by the SAX parser.

elInfoStack

private final Stack<SAXFilter.ElementInfo> elInfoStack

Stack of ElementInfo objects.

charBuf

private final StringBuilder charBuf

StringBuilder used to collect text during parsing.

documentURI

private ParsedIRI documentURI

The document's URI.

parseStandAloneDocuments

private boolean parseStandAloneDocuments

Flag indicating whether the parser parses stand-alone RDF documents. In stand-alone documents, the rdf:RDF element is optional if it contains just one element.

deferredElement

private SAXFilter.ElementInfo deferredElement

Variable used to defer reporting of start tags. Reporting start tags is deferred to be able to combine a start tag and an immediately following end tag to a single call to emptyElement().

newNamespaceMappings

private final Map<String,String> newNamespaceMappings

New namespace mappings that have been reported for the next start tag by the SAX parser, but that are not yet assigned to an ElementInfo object.

inRDFContext

private boolean inRDFContext

Flag indicating whether we're currently parsing RDF elements.

rdfContextStackHeight

private int rdfContextStackHeight

The number of elements on the stack that are in the RDF context.

parseLiteralMode

private boolean parseLiteralMode

Flag indicating whether we're currently parsing an XML literal.

xmlLiteralStackHeight

private int xmlLiteralStackHeight

The number of elements on the stack that are part of an XML literal.

xmlLiteralPrefixes

private final List<String> xmlLiteralPrefixes

The prefixes that are defined in the XML literal itself (this in contrast to the namespaces from the XML literal's context).

unknownPrefixesInXMLLiteral

private final List<String> unknownPrefixesInXMLLiteral

The prefixes that were used in an XML literal, but that were not defined in it (but rather in the XML literal's context).

Constructor Details

SAXFilter

public SAXFilter(RDFXMLParser rdfParser)

Method Details

getLocator

public Locator getLocator()

clear

public void clear()

setDocumentURI

public void setDocumentURI(String documentURI)

setParseStandAloneDocuments

public void setParseStandAloneDocuments(boolean standAloneDocs)

getParseStandAloneDocuments

public boolean getParseStandAloneDocuments()

setDocumentLocator

public void setDocumentLocator(Locator loc)

Specified by:

setDocumentLocator in interface ContentHandler

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)

Specified by:

endPrefixMapping in interface ContentHandler

startElement

public void startElement(String namespaceURI,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Throws:

SAXException

reportDeferredStartElement

private void reportDeferredStartElement()
                                 throws RDFParseException,
RDFHandlerException

Throws:

RDFParseException

RDFHandlerException

endElement

public void endElement(String namespaceURI,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)

Specified by:

ignorableWhitespace in interface ContentHandler

processingInstruction

public void processingInstruction(String target,
 String data)

Specified by:

processingInstruction in interface ContentHandler

skippedEntity

public void skippedEntity(String name)

Specified by:

skippedEntity in interface ContentHandler

checkAndCopyAttributes

private void checkAndCopyAttributes(Attributes attributes,
 SAXFilter.ElementInfo elInfo)
                             throws SAXException,
RDFParseException

Throws:

SAXException

RDFParseException

setParseLiteralMode

public void setParseLiteralMode()

createBaseURI

private ParsedIRI createBaseURI(String uriString)

appendStartTag

private void appendStartTag(String qName,
 Attributes attributes)

Appends a start tag to charBuf. This method is used during the parsing of an XML Literal.

appendEndTag

private void appendEndTag(String qName)

Appends an end tag to charBuf. This method is used during the parsing of an XML Literal.

insertUsedContextPrefixes

private void insertUsedContextPrefixes()

Inserts prefix mappings from an XML Literal's context for all prefixes that are used in the XML Literal and that are not defined in the XML Literal itself.

appendNamespaceDecl

private void appendNamespaceDecl(StringBuilder sb,
 String prefix,
 String namespace)

appendAttribute

private void appendAttribute(StringBuilder sb,
 String name,
 String value)

peekStack

private SAXFilter.ElementInfo peekStack()