RDFXMLParser (RDF4J: Rio - RDF/XML 2.4.5 API)

java.lang.Object
- org.eclipse.rdf4j.rio.helpers.AbstractRDFParser
- - org.eclipse.rdf4j.rio.helpers.XMLReaderBasedParser
  - - org.eclipse.rdf4j.rio.rdfxml.RDFXMLParser

All Implemented Interfaces:

RDFParser, ErrorHandler
```
public class RDFXMLParser
extends XMLReaderBasedParser
implements ErrorHandler
```
A parser for XML-serialized RDF. This parser operates directly on the SAX events generated by a SAX-enabled XML parser. The XML parser should be compliant with SAX2. You should specify which SAX parser should be used by setting the org.xml.sax.driver property. This parser is not thread-safe, therefore it's public methods are synchronized.
To parse a document using this parser:
- Create an instance of RDFXMLParser, optionally supplying it with your own ValueFactory.
- Set the RDFHandler.
- Optionally, set the ParseErrorListener and/or ParseLocationListener.
- Optionally, specify whether the parser should verify the data it parses and whether it should stop immediately when it finds an error in the data (both default to true).
- Call the parse method.
Example code:
```
 // Use the SAX2-compliant Xerces parser:
 System.setProperty("org.xml.sax.driver", "org.apache.xerces.parsers.SAXParser");
 
 RDFParser parser = new RDFXMLParser();
 parser.setRDFHandler(myRDFHandler);
 parser.setParseErrorListener(myParseErrorListener);
 parser.setVerifyData(true);
 parser.stopAtFirstError(false);
 
 // Parse the data from inputStream, resolving any
 // relative URIs against http://foo/bar:
 parser.parse(inputStream, "http://foo/bar");
 
```
Author:

Arjohn Kampman

See Also:

ValueFactory, RDFHandler, ParseErrorListener, ParseLocationListener

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.rdf4j.rio.RDFParser
  RDFParser.DatatypeHandling

Field Summary
- Fields inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFParser
  rdfHandler, valueFactory

Constructor Summary

Constructors
Constructor and Description
`RDFXMLParser()` Creates a new RDFXMLParser that will use a `SimpleValueFactory` to create RDF model objects.
`RDFXMLParser(ValueFactory valueFactory)` Creates a new RDFXMLParser that will use the supplied `ValueFactory` to create RDF model objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Literal`	`createLiteral(String label, String lang, IRI datatype)`
`protected Resource`	`createNode(String nodeID)`
`void`	`error(SAXParseException exception)` Implementation of SAX ErrorHandler.error
`void`	`fatalError(SAXParseException exception)` Implementation of SAX ErrorHandler.fatalError
`boolean`	`getParseStandAloneDocuments()` Returns whether the parser is currently in a mode to parse stand-alone RDF documents.
`RDFFormat`	`getRDFFormat()`
`SAXResult`	`getSAXResult(String baseURI)`
`Collection<RioSetting<?>>`	`getSupportedSettings()`
`void`	`parse(InputStream in, String baseURI)` Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.
`void`	`parse(Reader reader, String baseURI)` Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.
`protected void`	`reportError(Exception e, RioSetting<Boolean> setting)` Overrides `AbstractRDFParser.reportError(String, RioSetting)`, adding line- and column number information to the error.
`protected void`	`reportError(String msg, RioSetting<Boolean> setting)` Overrides `AbstractRDFParser.reportError(String, RioSetting)`, adding line- and column number information to the error.
`protected void`	`reportFatalError(Exception e)` Overrides `AbstractRDFParser.reportFatalError(Exception)`, adding line- and column number information to the error.
`protected void`	`reportFatalError(String msg)` Overrides `AbstractRDFParser.reportFatalError(String)`, adding line- and column number information to the error.
`protected void`	`reportWarning(String msg)` Overrides `AbstractRDFParser.reportWarning(String)`, adding line- and column number information to the error.
`protected void`	`setBaseURI(ParsedURI baseURI)`
`protected void`	`setBaseURI(String baseURI)`
`void`	`setParseStandAloneDocuments(boolean standAloneDocs)` Sets the parser in a mode to parse stand-alone RDF documents.
`void`	`warning(SAXParseException exception)` Implementation of SAX ErrorHandler.warning

Methods inherited from class org.eclipse.rdf4j.rio.helpers.XMLReaderBasedParser
getCompulsoryXmlFeatureSettings, getCompulsoryXmlPropertySettings, getOptionalXmlFeatureSettings, getOptionalXmlPropertySettings, getXMLReader

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RDFXMLParser
```
public RDFXMLParser()
```
    Creates a new RDFXMLParser that will use a SimpleValueFactory to create RDF model objects.
  - RDFXMLParser
```
public RDFXMLParser(ValueFactory valueFactory)
```
    Creates a new RDFXMLParser that will use the supplied ValueFactory to create RDF model objects.
    
    Parameters:
    
    valueFactory - A ValueFactory.
- Method Detail
  - getRDFFormat
```
public final RDFFormat getRDFFormat()
```
    Specified by:
    
    getRDFFormat in interface RDFParser
  - setParseStandAloneDocuments
```
public void setParseStandAloneDocuments(boolean standAloneDocs)
```
    Sets the parser in a mode to parse stand-alone RDF documents. In stand-alone RDF documents, the enclosing rdf:RDF root element is optional if this root element contains just one element (e.g. rdf:Description.
  - getParseStandAloneDocuments
```
public boolean getParseStandAloneDocuments()
```
    Returns whether the parser is currently in a mode to parse stand-alone RDF documents.
    
    See Also:
    
    setParseStandAloneDocuments(boolean)
  - parse
```
public void parse(InputStream in,
                  String baseURI)
           throws IOException,
                  RDFParseException,
                  RDFHandlerException
```
    Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.
    
    Specified by:
    
    parse in interface RDFParser
    
    Parameters:
    
    in - The InputStream from which to read the data, must not be null.
    
    baseURI - The URI associated with the data in the InputStream, must not be null.
    
    Throws:
    
    IOException - If an I/O error occurred while data was read from the InputStream.
    
    RDFParseException - If the parser has found an unrecoverable parse error.
    
    RDFHandlerException - If the configured statement handler encountered an unrecoverable error.
    
    IllegalArgumentException - If the supplied input stream or base URI is null.
  - parse
```
public void parse(Reader reader,
                  String baseURI)
           throws IOException,
                  RDFParseException,
                  RDFHandlerException
```
    Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.
    
    Specified by:
    
    parse in interface RDFParser
    
    Parameters:
    
    reader - The Reader from which to read the data, must not be null.
    
    baseURI - The URI associated with the data in the InputStream, must not be null.
    
    Throws:
    
    IOException - If an I/O error occurred while data was read from the InputStream.
    
    RDFParseException - If the parser has found an unrecoverable parse error.
    
    RDFHandlerException - If the configured statement handler has encountered an unrecoverable error.
    
    IllegalArgumentException - If the supplied reader or base URI is null.
  - getSupportedSettings
```
public Collection<RioSetting<?>> getSupportedSettings()
```
    Specified by:
    
    getSupportedSettings in interface RDFParser
    
    Overrides:
    
    getSupportedSettings in class AbstractRDFParser
  - getSAXResult
```
public SAXResult getSAXResult(String baseURI)
```
  - setBaseURI
```
protected void setBaseURI(ParsedURI baseURI)
```
    Overrides:
    
    setBaseURI in class AbstractRDFParser
  - setBaseURI
```
protected void setBaseURI(String baseURI)
```
    Overrides:
    
    setBaseURI in class AbstractRDFParser
  - createNode
```
protected Resource createNode(String nodeID)
                       throws RDFParseException
```
    Overrides:
    
    createNode in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - createLiteral
```
protected Literal createLiteral(String label,
                                String lang,
                                IRI datatype)
                         throws RDFParseException
```
    Overrides:
    
    createLiteral in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - reportWarning
```
protected void reportWarning(String msg)
```
    Overrides AbstractRDFParser.reportWarning(String), adding line- and column number information to the error.
    
    Overrides:
    
    reportWarning in class AbstractRDFParser
  - reportError
```
protected void reportError(String msg,
                           RioSetting<Boolean> setting)
                    throws RDFParseException
```
    Overrides AbstractRDFParser.reportError(String, RioSetting), adding line- and column number information to the error.
    
    Overrides:
    
    reportError in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - reportError
```
protected void reportError(Exception e,
                           RioSetting<Boolean> setting)
                    throws RDFParseException
```
    Overrides AbstractRDFParser.reportError(String, RioSetting), adding line- and column number information to the error.
    
    Overrides:
    
    reportError in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - reportFatalError
```
protected void reportFatalError(String msg)
                         throws RDFParseException
```
    Overrides AbstractRDFParser.reportFatalError(String), adding line- and column number information to the error.
    
    Overrides:
    
    reportFatalError in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - reportFatalError
```
protected void reportFatalError(Exception e)
                         throws RDFParseException
```
    Overrides AbstractRDFParser.reportFatalError(Exception), adding line- and column number information to the error.
    
    Overrides:
    
    reportFatalError in class AbstractRDFParser
    
    Throws:
    
    RDFParseException
  - warning
```
public void warning(SAXParseException exception)
             throws SAXException
```
    Implementation of SAX ErrorHandler.warning
    
    Specified by:
    
    warning in interface ErrorHandler
    
    Throws:
    
    SAXException
  - error
```
public void error(SAXParseException exception)
           throws SAXException
```
    Implementation of SAX ErrorHandler.error
    
    Specified by:
    
    error in interface ErrorHandler
    
    Throws:
    
    SAXException
  - fatalError
```
public void fatalError(SAXParseException exception)
                throws SAXException
```
    Implementation of SAX ErrorHandler.fatalError
    
    Specified by:
    
    fatalError in interface ErrorHandler
    
    Throws:
    
    SAXException

Class RDFXMLParser

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.rdf4j.rio.RDFParser

Field Summary

Fields inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFParser

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.rdf4j.rio.helpers.XMLReaderBasedParser

Methods inherited from class org.eclipse.rdf4j.rio.helpers.AbstractRDFParser

Methods inherited from class java.lang.Object

Constructor Detail

RDFXMLParser

RDFXMLParser

Method Detail

getRDFFormat

setParseStandAloneDocuments

getParseStandAloneDocuments

parse

parse

getSupportedSettings

getSAXResult

setBaseURI

setBaseURI

createNode

createLiteral

reportWarning

reportError

reportError

reportFatalError

reportFatalError

warning

error

fatalError