com.hp.hpl.jena.rdf.model.ModelCon Maven / Gradle / Ivy
Show all versions of jena Show documentation
/*
* (c) Copyright 2000, 2001, 2002, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Hewlett-Packard Development Company, LP
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ModelCon.java
*
* Created on 7 December 2001, 11:00
*/
package com.hp.hpl.jena.rdf.model;
import java.util.Calendar;
import com.hp.hpl.jena.datatypes.RDFDatatype;
import com.hp.hpl.jena.graph.Node;
/** Convenience methods which extend the {@link Model} interface.
* The {@link Model} interface provides a set of primitive operations on
* an RDF model. This interface extends those methods with a
* set of convenience methods.
* This interface provides methods supporting typed literals. This means
* that methods are provided which will translate a built in type, or an
* object to an RDF Literal. This translation is done by invoking the
* toString() method of the object, or its built in equivalent.
* The reverse translation is also supported. This is built in for built
* in types. Factory objects, provided by the application, are used
* for application objects.
* This interface provides methods for supporting enhanced resources. An
* enhanced resource is a resource to which the application has added
* behaviour. RDF containers are examples of enhanced resources built in
* to this package. Enhanced resources are supported by encapsulating a
* resource created by an implementation in another class which adds
* the extra behaviour. Factory objects are used to construct such
* enhanced resources.
* @author bwm
* @version Release='$Name: $'
Revision='$Revision: 1.2 $'
Date='$Date: 2009/09/28 10:45:11 $'
*/
public interface ModelCon {
/** Return a Resource instance in this model.
*
* Subsequent operations on the returned object may modify this model.
* The resource is assumed to already exist in the model. If it does not,
* createResource should be used instead.
* @return a resource instance created by the factory provided
* @param uri the URI of the resource
* @param f the factory object
*/
@Deprecated Resource getResource(String uri, ResourceF f) ;
/** Return a Property instance in this model.
*
* Subsequent operations on the returned property may modify this model.
* The property is assumed to already exist in the model. If it does not,
* createProperty should be used instead.
* @return a property object
* @param uri the URI of the property
*/
Property getProperty(String uri) ;
/** Return a Bag instance in this model.
*
* Subsequent operations on the returned bag may modify this model.
* The bag is assumed to already exist in the model. If it does not,
* createBag should be used instead.
* @return a bag instance
* @param uri the URI of the bag.
*/
Bag getBag(String uri) ;
/** Return a bag instance based on a given resource.
*
* This method enables an application to treat any resource as a bag.
* It is in effect an unsafe downcast.
*
* Subsequent operations on the returned bag may modify this model.
* The bag is assumed to already exist in the model. If it does not,
* createBag should be used instead.
* @return a bag instance
* @param r an untyped Resource instance
*/
Bag getBag(Resource r) ;
/** Return an Alt instance in this model.
*
* Subsequent operations on the returned object may modify this model.
* The alt is assumed to already exist in the model. If it does not,
* createAlt should be used instead.
* @return an alt instance
* @param uri the URI of the alt
*/
Alt getAlt(String uri) ;
/** Return an Alt instance based on a given resource.
*
* This method enables an application to treat any resource as an Alt.
* It is in effect an unsafe downcast.
*
* Subsequent operations on the returned Alt may modify this model.
* The bag is assumed to already exist in the model. If it does not,
* createAlt should be used instead.
* @return an Alt instance
* @param r an untyped Resource instance
*/
Alt getAlt(Resource r) ;
/** Return a Seq instance in this model.
*
* Subsequent operations on the returned bag may modify this model.
* The seq is assumed to already exist in the model. If it does not,
* createSeq should be used instead.
* @return a seq instance
* @param uri the URI of the seq
*/
Seq getSeq(String uri) ;
/** Return a Seq instance based on a given resource.
*
* This method enables an application to treat any resource as a Seq.
* It is in effect an unsafe downcast.
*
* Subsequent operations on the returned Seq may modify this model.
* The Seq is assumed to already exist in the model. If it does not,
* createAlt should be used instead.
* @return an Alt instance
* @param r an untyped Resource instance
*/
Seq getSeq(Resource r) ;
/** Create a new anonymous resource with a given type.
*
* Subsequent operations on the returned resource may modify this model.
*
* The resource is created and an rdf:type property added to the model
* to specify its type.
* @param type the type of the resource to be created.
* @return a new anonymous resource linked to this model.
*/
public Resource createResource(Resource type) ;
/**
Create or find an RDFNode
(a {@link Resource} or a {@link Literal})
from a graph Node. This is provided for users and
developers operating at the API/SPI interface, where Resources are
constructed from Nodes. Providing this method allows each Model
the opportunity to cache node-to-resource maps if it requires.
@param n the graph.Node on which to base the Model.RDFNode
@return a suitable RDFNode
*/
public RDFNode getRDFNode( Node n );
/** Create a new resource with a given type.
*
* Subsequent operations on the returned resource may modify this model.
*
* The resource is created and an rdf:type property added to the model
* to specify its type.
* @param type the type of the resource to be created.
* @return a new resource linked to this model.
* @param uri The URI of the new resource.
*/
public Resource createResource(String uri, Resource type);
/** Create a new anonymous resource using the supplied factory.
*
* Subsequent operations on the returned resource may modify this model.
*
* @return a new anonymous resource linked to this model.
* @param f A factory object to create the returned object.
.
*/
@Deprecated public Resource createResource(ResourceF f) ;
/** Create a new resource using the supplied factory.
*
* Subsequent operations on the returned resource may modify this model.
*
* @return a new resource linked to this model.
* @param uri the URI of the resource
* @param f A factory to create the returned object.
.
*/
@Deprecated public Resource createResource(String uri, ResourceF f) ;
/** Create a property.
*
* Subsequent operations on the returned property may modify this model.
*
* @param uri the URI of the property
* @return a property instance
*/
public Property createProperty(String uri) ;
/** create a literal from a String value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createLiteral( String v );
/** create a type literal from a boolean value.
*
* The value is converted to a string using its toString
* method.
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(boolean v) ;
/** create a typed literal from an integer value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(int v) ;
/** create a typed literal from an integer value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(long v) ;
/**
* Create a typed literal of type xsd:dateTime from a Calendar object.
*/
public Literal createTypedLiteral(Calendar d);
/** create a typed literal from a char value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(char v) ;
/** create a typed literal from a float value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(float v) ;
/** create a typed literal from a double value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(double v) ;
/** create a typed literal from a String value.
*
* @param v the value of the literal
* @return a new literal representing the value v
*/
public Literal createTypedLiteral(String v) ;
/** create a literal from an Object.
*
* @return a new literal representing the value v
* @param v the value of the literal.
*/
public Literal createTypedLiteral(Object v) ;
/**
* Build a typed literal from its lexical form. The
* lexical form will be parsed now and the value stored. If
* the form is not legal this will throw an exception.
*
* Note that in preview releases of Jena2 it was also possible to specify
* a language type. Changes to the RDF specification mean that this is no longer
* legal except for plain literals. To create a plain literal with a language tag
* use {@link Model#createLiteral(String, String) createLiteral}.
*
*
* @param lex the lexical form of the literal
* @param typeURI the uri of the type of the literal, null for old style "plain" literals
* @throws DatatypeFormatException if lex is not a legal form of dtype
*/
public Literal createTypedLiteral(String lex, String typeURI) ;
/**
* Build a typed literal from its value form.
*
* Note that in preview releases of Jena2 it was also possible to specify
* a language type. Changes to the RDF specification mean that this is no longer
* legal except for plain literals. To create a plain literal with a language tag
* use {@link Model#createLiteral(String, String) createLiteral}.
*
*
* @param value the value of the literal
* @param typeURI the URI of the type of the literal, null for old style "plain" literals
*/
public Literal createTypedLiteral(Object value, String typeURI);
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, boolean o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, float o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, double o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, long o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, int o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, char o );
/**
Answer a new Statement object (s, p, o') where o' is the typed literal
corresponding to o using createTypedLiteral.
*/
public Statement createLiteralStatement( Resource s, Property p, Object o );
/** Create a Statement instance.
*
* Subsequent operations on the statement or any of its parts may
* modify this model.
* Creating a statement does not add it to the set of statements in the
* model.
* The Object o will be converted to a Literal.
* @param s the subject of the statement
* @param p the predicate of the statement
* @param o is the value to be the object of the statement
* @return the new statement
*/
public Statement createStatement(Resource s, Property p, String o) ;
/** Create a Statement instance.
*
* Subsequent operations on the statement or any of its parts may
* modify this model.
* Creating a statement does not add it to the set of statements in the
* model.
* The Object o will be converted to a Literal.
* @param s the subject of the statement
* @param p the predicate of the statement
* @param o is the value to be the object of the statement
* @param l the language associated with the object
* @return the new statement
*/
public Statement createStatement(Resource s, Property p, String o, String l) ;
/** Create a Statement instance.
*
* Subsequent operations on the statement or any of its parts may
* modify this model.
* Creating a statement does not add it to the set of statements in the
* model.
* The Object o will be converted to a Literal.
* @param s the subject of the statement
* @param p the predicate of the statement
* @param o is the value to be the object of the statement
* @param wellFormed true if the string is well formed XML
* @return the new statement
*/
public Statement createStatement(Resource s, Property p, String o,
boolean wellFormed) ;
/** Create a Statement instance.
*
* Subsequent operations on the statement or any of its parts may
* modify this model.
* Creating a statement does not add it to the set of statements in the
* model.
* The Object o will be converted to a Literal.
* @param s the subject of the statement
* @param p the predicate of the statement
* @param o is the value to be the object of the statement
* @param l the language associated with the object
* @param wellFormed true of the string is well formed XML
* @return the new statement
*/
public Statement createStatement(Resource s, Property p, String o, String l, boolean wellFormed) ;
/** Create a new anonymous bag.
*
* Subsequent operations on the bag or any of its parts may
* modify this model.
* A statement defining the type of the new bag is added to this model.
*
* @return a new anonymous bag.
*/
public Bag createBag() ;
/** Create a new bag.
*
* Subsequent operations on the bag or any of its parts may
* modify this model.
* A statement defining the type of the new bag is added to this model.
*
* @param uri The URI of the new Bag.
* @return a new bag.
*/
public Bag createBag(String uri) ;
/** Create a new anonymous alt.
*
* Subsequent operations on the alt or any of its parts may
* modify this model.
* A statement defining the type of the new alt is added to this model.
*
* @return a new anonymous alt.
*/
public Alt createAlt() ;
/** Create a new alt.
*
* Subsequent operations on the alt or any of its parts may
* modify this model.
* A statement defining the type of the new alt is added to this model.
*
* @param uri The URI of the new alt.
* @return a new alt.
*/
public Alt createAlt(String uri) ;
/** Create a new anonymous seq.
*
* Subsequent operations on the seq or any of its parts may
* modify this model.
* A statement defining the type of the new seq is added to this model.
*
* @return a new anonymous seq.
*/
public Seq createSeq() ;
/** Create a new seq.
*
* Subsequent operations on the seq or any of its parts may
* modify this model.
* A statement defining the type of the new seq is added to this model.
*
* @param uri The URI of the new seq.
* @return a new seq.
*/
public Seq createSeq(String uri) ;
/** add a statement to this model.
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
*/
Model add(Resource s, Property p, RDFNode o) ;
/**
Add the statement (s, p, createTypedLiteral( o )) to this model and
answer this model.
*/
Model addLiteral( Resource s, Property p, boolean o );
/**
Add the statement (s, p, createTypedLiteral( o )) to this model and
answer this model.
*/
Model addLiteral( Resource s, Property p, long o );
/**
Add the statement (s, p, createTypedLiteral( o )) to this model and
answer this model.
*/
Model addLiteral( Resource s, Property p, int o );
/**
Add the statement (s, p, createTypedLiteral( o )) to this model and
answer this model.
*/
Model addLiteral( Resource s, Property p, char o ) ;
/**
Add the statement (s, p, o') to the model, where o' is the typed
literal corresponding to o. Answer this model.
*/
Model addLiteral( Resource s, Property p, float o );
/**
Add the statement (s, p, o') to the model, where o' is the typed
literal corresponding to o. Answer this model.
*/
Model addLiteral( Resource s, Property p, double o ) ;
/** add a statement to this model.
* Applications should use typed literals whereever possible.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
* @deprecated Freshly (should have been done a while ago)
*/
@Deprecated Model addLiteral( Resource s, Property p, Object o );
/** add a statement to this model.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
*/
Model addLiteral( Resource s, Property p, Literal o );
/** add a statement to this model.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
*/
Model add(Resource s, Property p, String o) ;
/** add a statement to this model.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param lex the lexcial form of the literal
* @param datatype the datatype of the literal
*/
Model add(Resource s, Property p, String lex, RDFDatatype datatype) ;
/** add a statement to this model.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
* @param wellFormed true if o is well formed XML
*/
Model add(Resource s, Property p, String o, boolean wellFormed);
/** add a statement to this model.
*
* @return this model
* @param s the subject of the statement to add
* @param p the predicate of the statement to add
* @param o the object of the statement to add
* @param l the language associated with the object
*/
Model add(Resource s, Property p, String o, String l) ;
/**
remove the statement (s, p, o) from this model and
answer this model. None of s, p, o are permitted to
be null: for wildcard removal, see removeAll.
*/
Model remove( Resource s, Property p, RDFNode o );
/** Remove all the Statements returned by an iterator.
* @return this model
* @param iter the iterator which returns the statements to be removed.
*/
Model remove(StmtIterator iter) ;
/** Remove all the Statements in a given model, including reified statements
* @return this model
* @param m the model containing the statements to be removed.
*/
Model remove(Model m) ;
/**
Remove from this model all the statements found in the given model.
If suppressreifications is true, remove the reified statements of m as well.
@param m the model containing the statements to remove
@param suppressReifications true to remove reified statements too
@return this model for cascading
*/
Model remove( Model m, boolean suppressReifications );
/**
Answer a statement iterator that will iterate over all the statements
(S, P, O) in this model where S matches subject, P
matches predicate, and O matches the typed literal
corresponding to object.
*/
StmtIterator listLiteralStatements( Resource subject, Property predicate, boolean object );
/**
Answer a statement iterator that will iterate over all the statements
(S, P, O) in this model where S matches subject, P
matches predicate, and O matches the typed literal
corresponding to object.
*/
StmtIterator listLiteralStatements( Resource subject, Property predicate, char object );
/**
Answer a statement iterator that will iterate over all the statements
(S, P, O) in this model where S matches subject, P
matches predicate, and O matches the typed literal
corresponding to object.
*/
StmtIterator listLiteralStatements(Resource subject, Property predicate, long object );
/**
Answer a statement iterator that will iterate over all the statements
(S, P, O) in this model where S matches subject, P
matches predicate, and O matches the typed literal
corresponding to object.
*/
StmtIterator listLiteralStatements( Resource subject, Property predicate, float object );
/**
Answer a statement iterator that will iterate over all the statements
(S, P, O) in this model where S matches subject, P
matches predicate, and O matches the typed literal
corresponding to object.
*/
StmtIterator listLiteralStatements(Resource subject, Property predicate, double object );
/** Find all the statements matching a pattern.
* Return an iterator over all the statements in a model
* that match a pattern. The statements selected are those
* whose subject matches the subject argument,
* whose predicate matches the predicate argument
* and whose object matchesthe object argument.
* @return an iterator over the subjects
* @param subject The subject sought
* @param predicate The predicate sought
* @param object The value sought
*/
StmtIterator listStatements( Resource subject, Property predicate, String object );
/** Find all the statements matching a pattern.
* Return an iterator over all the statements in a model
* that match a pattern. The statements selected are those
* whose subject matches the subject argument,
* whose predicate matches the predicate argument
* and whose object matchesthe object argument.
* If an argument is null it matches anything.
* @return an iterator over the subjects
* @param subject The subject sought
* @param predicate The predicate sought
* @param object The value sought
* @param lang The lang code ofthe string.
*/
StmtIterator listStatements(Resource subject,
Property predicate,
String object,
String lang)
;
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, boolean o );
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, long o );
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, char o );
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, float o );
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, double o );
/**
Answer an iterator [without duplicates] over all the resources in this
model which have value o' for property p, where o' is the typed literal
corresponding to o.
*/
ResIterator listResourcesWithProperty( Property p, Object o );
/** lists all subjects with a given property and property value.
* @return an iterator over the set of subjects
* @param p The predicate sought.
* @param o The property value sought.
*/
ResIterator listSubjectsWithProperty( Property p, String o );
/** lists all subjects with a given property and property value.
* @return an iterator over the set of subjects
* @param p The predicate sought.
* @param o The property value sought.
* @param l the language associated with the object
*/
ResIterator listSubjectsWithProperty( Property p, String o, String l );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, boolean o );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, long o );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, int o );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, char o );
/**
Answer true iff this model contains (s, p, o') where o' is the typed
literal corresponding to o.
*/
boolean containsLiteral( Resource s, Property p, float o );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, double o );
/**
Answer true iff this model contains the statement (s, p, o') where
o' is the typed literal corresponding to the value o.
*/
boolean containsLiteral( Resource s, Property p, Object o );
/** Determine if a statement is present in this model.
* @return true if the statement with subject s, property p and object o
* is in the model, false otherwise
* @param s The subject of the statment tested.
* @param p The predicate of the statement tested.
* @param o The object of the statement tested.
*/
boolean contains( Resource s, Property p, String o );
/** Determine if a statement is present in this model.
* @return true if the statement with subject s, property p and object o
* is in the model, false otherwise
* @param s The subject of the statment tested.
* @param p The predicate of the statement tested.
* @param o The object of the statement tested.
* @param l the language associated with the object
*/
boolean contains( Resource s, Property p, String o, String l );
}