org.eclipse.rdf4j.rio.RDFParser Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015 Eclipse RDF4J contributors, Aduna, and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Distribution License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*******************************************************************************/
package org.eclipse.rdf4j.rio;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.util.Collection;
import org.eclipse.rdf4j.model.ValueFactory;
import org.eclipse.rdf4j.rio.helpers.BasicParserSettings;
/**
* An interface for RDF parsers. All implementing classes should define a public zero-argument constructor to allow them
* to be created through reflection.
*/
public interface RDFParser {
/*-----------*
* Constants *
*-----------*/
/**
* @deprecated These settings are not recognised and will be removed in a future version. Use
* {@link BasicParserSettings#FAIL_ON_UNKNOWN_DATATYPES}
* {@link BasicParserSettings#NORMALIZE_DATATYPE_VALUES} and
* {@link BasicParserSettings#VERIFY_DATATYPE_VALUES} instead.
*/
@Deprecated
public enum DatatypeHandling {
/**
* Indicates that datatype semantics should be ignored.
*/
IGNORE,
/**
* Indicates that values of datatyped literals should be verified.
*/
VERIFY,
/**
* Indicates that values of datatyped literals should be normalized to their canonical representation.
*/
NORMALIZE
}
/*---------*
* Methods *
*---------*/
/**
* Gets the RDF format that this parser can parse.
*/
public RDFFormat getRDFFormat();
/**
* Sets the ValueFactory that the parser will use to create Value objects for the parsed RDF data.
*
* @param valueFactory The value factory that the parser should use.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser setValueFactory(ValueFactory valueFactory);
/**
* Sets the RDFHandler that will handle the parsed RDF data.
*
* @param handler The RDFHandler to handle the parsed data.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser setRDFHandler(RDFHandler handler);
/**
* Sets the ParseErrorListener that will be notified of any errors that this parser finds during parsing.
*
* @param el The ParseErrorListener that will be notified of errors or warnings.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser setParseErrorListener(ParseErrorListener el);
/**
* Sets the ParseLocationListener that will be notified of the parser's progress during the parse process.
*
* @param ll The ParseLocationListener that will be notified of the parser's progress.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser setParseLocationListener(ParseLocationListener ll);
/**
* Sets all supplied parser configuration options.
*
* @param config a parser configuration object.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser setParserConfig(ParserConfig config);
/**
* Retrieves the current parser configuration as a single object.
*
* @return a parser configuration object representing the current configuration of the parser.
*/
public ParserConfig getParserConfig();
/**
* @return A collection of {@link RioSetting}s that are supported by this RDFParser.
*/
public Collection> getSupportedSettings();
/**
* Set a setting on the parser, and return this parser object to allow chaining.
*
* @param setting The setting to change.
* @param value The value to change.
* @return Either a copy of this parser, if it is immutable, or this object, to allow chaining of method calls.
*/
public RDFParser set(RioSetting setting, T value);
/**
* Sets whether the parser should verify the data it parses (default value is true).
*
* @deprecated since 2.0. Use {@link #getParserConfig()} with {@link BasicParserSettings#FAIL_ON_UNKNOWN_DATATYPES},
* {@link BasicParserSettings#VERIFY_DATATYPE_VALUES}, and/or
* {@link BasicParserSettings#NORMALIZE_DATATYPE_VALUES} instead.
*/
@Deprecated
public void setVerifyData(boolean verifyData);
/**
* Set whether the parser should preserve bnode identifiers specified in the source (default is false).
*/
public void setPreserveBNodeIDs(boolean preserveBNodeIDs);
/**
* Sets whether the parser should stop immediately if it finds an error in the data (default value is
* true).
*
* @deprecated since 2.0. Use {@link #getParserConfig()} with {@link ParserConfig#addNonFatalError(RioSetting)} to
* select which errors will not always fail the parse prematurely.
*/
@Deprecated
public void setStopAtFirstError(boolean stopAtFirstError);
/**
* Sets the datatype handling mode. There are three modes for handling datatyped literals: ignore ,
* verifyand normalize . If set to ignore, no special action will be taken to handle
* datatyped literals. If set to verify, any literals with known (XML Schema built-in) datatypes are
* checked to see if their values are valid. If set to normalize, the literal values are not only checked,
* but also normalized to their canonical representation. The default value is verify.
*
* @param datatypeHandling A datatype handling option.
* @deprecated since 2.0. Use {@link #getParserConfig()} with {@link BasicParserSettings#FAIL_ON_UNKNOWN_DATATYPES},
* {@link BasicParserSettings#VERIFY_DATATYPE_VALUES}, and/or
* {@link BasicParserSettings#NORMALIZE_DATATYPE_VALUES} instead.
*/
@Deprecated
public void setDatatypeHandling(DatatypeHandling datatypeHandling);
/**
* Parses the data from the supplied InputStream, using the supplied baseURI to resolve any relative URI references.
*
* @param in The InputStream from which to read the data.
* @param baseURI The URI associated with the data in the InputStream.
* @throws IOException If an I/O error occurred while data was read from the InputStream.
* @throws RDFParseException If the parser has found an unrecoverable parse error.
* @throws RDFHandlerException If the configured statement handler has encountered an unrecoverable error.
*/
public void parse(InputStream in, String baseURI) throws IOException, RDFParseException, RDFHandlerException;
/**
* Parses the data from the supplied Reader, using the supplied baseURI to resolve any relative URI references.
*
* @param reader The Reader from which to read the data.
* @param baseURI The URI associated with the data in the InputStream.
* @throws IOException If an I/O error occurred while data was read from the InputStream.
* @throws RDFParseException If the parser has found an unrecoverable parse error.
* @throws RDFHandlerException If the configured statement handler has encountered an unrecoverable error.
*/
public void parse(Reader reader, String baseURI) throws IOException, RDFParseException, RDFHandlerException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy