com.hp.hpl.mesa.rdf.jena.model
Interface Resource

All Superinterfaces:
RDFNode
All Known Subinterfaces:
Alt, Bag, Container, DAMLClass, DAMLCommon, DAMLDataInstance, DAMLDatatype, DAMLDatatypeProperty, DAMLDisjoint, DAMLInstance, DAMLList, DAMLObjectProperty, DAMLOntology, DAMLProperty, DAMLRestriction, Datatype, Property, Seq, Statement
All Known Implementing Classes:
EnhResource, ResourceImpl, ResTestObj

public interface Resource
extends RDFNode

An RDF Resource.

Resource instances when created are associated with a specific model. They support a range of methods, such as getProperty() and addProperty() which will access or modify that model. This enables the programmer to write code in a compact and easy style.

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.

Version:
Release='$Name: $' Revision='$Revision: 1.3 $' Date='$Date: 2001/07/25 11:49:41 $'
Author:
bwm

Method Summary
 Resource abort()
          Abort the transaction in the associated model.
 Resource addProperty(Property p, boolean o)
          Add a property to this resource.
 Resource addProperty(Property p, char o)
          Add a property to this resource.
 Resource addProperty(Property p, double o)
          Add a property to this resource.
 Resource addProperty(Property p, float o)
          Add a property to this resource.
 Resource addProperty(Property p, long o)
          Add a property to this resource.
 Resource addProperty(Property p, java.lang.Object o)
          Add a property to this resource.
 Resource addProperty(Property p, RDFNode o)
          Add a property to this resource.
 Resource addProperty(Property p, java.lang.String o)
          Add a property to this resource.
 Resource addProperty(Property p, java.lang.String o, java.lang.String l)
          Add a property to this resource.
 Resource begin()
          Begin a transaction in the associated model.
 Resource commit()
          Commit the transaction in the associated model.
 boolean equals(java.lang.Object o)
          Determine whether two objects represent the same resource.
 AnonId getId()
          Returns an a unique identifier for anonymous resources.
 java.lang.String getLocalName()
          Returns the name of this resource within its namespace.
 Model getModel()
          Return the model associated with this resource.
 java.lang.String getNameSpace()
          Returns the namespace associated with this resource.
 Statement getProperty(Property p)
          Get a property value of this resource.
 java.lang.String getURI()
          Return the URI of the resource, or the empty string if it is anonymous.
 boolean hasProperty(Property p)
          Determine whether this resource has any values for a given property.
 boolean hasProperty(Property p, boolean o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, char o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, double o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, float o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, long o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, java.lang.Object o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, RDFNode o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, java.lang.String o)
          Test if this resource has a given property with a given value.
 boolean hasProperty(Property p, java.lang.String o, java.lang.String l)
          Test if this resource has a given property with a given value.
 boolean isAnon()
          Determine whether this resource is anonymous.
 StmtIterator listProperties()
          Return an iterator over all the properties of this resource.
 StmtIterator listProperties(Property p)
          List all the values of the property p.
 Resource removeProperties()
          Delete all the properties for this resource from the associated model.
 java.lang.String toString()
          Return a string representation of the resource.
 

Method Detail

getId

public AnonId getId()
             throws RDFException
Returns an a unique identifier for anonymous resources.

The id is unique within the scope of a particular implementation. All models within an implementation will use the same id for the same anonymous resource.

This method is undefined if called on resources which are not anonymous and may raise an exception.

Returns:
A unique id for an anonymous resource.
Throws:
RDFException - Generic RDF exception.

getURI

public java.lang.String getURI()
Return the URI of the resource, or the empty string if it is anonymous.
Returns:
The URI of the resource, or the empty string if it is anonymous.

getNameSpace

public java.lang.String getNameSpace()
Returns the namespace associated with this resource.
Returns:
The namespace for this property.

getLocalName

public java.lang.String getLocalName()
Returns the name of this resource within its namespace.
Returns:
The name of this property within its namespace.

toString

public java.lang.String toString()
Return a string representation of the resource. Returns the URI of the resource unless the resource is anonymous in which case it returns the id of the resource enclosed in square brackets.
Specified by:
toString in interface RDFNode
Overrides:
toString in class java.lang.Object
Returns:
Return a string representation of the resource. if it is anonymous.

equals

public boolean equals(java.lang.Object o)
Determine whether two objects represent the same resource.

A resource can only be equal to another resource. If both resources are not anonymous, then they are equal if the URI's are equal. If both resources are anonymous, they are equal only if there Id's are the same. If one resource is anonymous and the other is not, then they are not equal.

Overrides:
equals in class java.lang.Object
Parameters:
o - The object to be compared.
Returns:
true if and only if both objects are equal

isAnon

public boolean isAnon()
Determine whether this resource is anonymous.
Returns:
Return true if and only if this resource is anonymous.

getProperty

public Statement getProperty(Property p)
                      throws RDFException
Get a property value of this resource.

The model associated with the resource instance is searched for statements whose subject is this resource and whose predicate is p. If such a statement is found, it is returned. If several such statements are found, any one may be returned. If no such statements are found, and exception is thrown.

Parameters:
p - The property sought.
Returns:
A statement specifying the property value.
Throws:
RDFException - Generic RDF exception.

listProperties

public StmtIterator listProperties(Property p)
                            throws RDFException
List all the values of the property p.

Returns an iterator over all the statements in the associated model whose subject is this resource and whose predicate is p.

Parameters:
p - The predicate sought.
Returns:
An iterator over the statements.
Throws:
RDFException - Generic RDF exception.

listProperties

public StmtIterator listProperties()
                            throws RDFException
Return an iterator over all the properties of this resource.

The model associated with this resource is search and an iterator is returned which iterates over all the statements which have this resource as a subject.

Returns:
An iterator over all the statements about this object.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            boolean o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            long o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            char o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            float o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            double o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            java.lang.String o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            java.lang.String o,
                            java.lang.String l)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

Parameters:
p - The property to be added.
o - The value of the property to be added.
l - the language of the property
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            java.lang.Object o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

o is converted to a string by calling its toString() method.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

addProperty

public Resource addProperty(Property p,
                            RDFNode o)
                     throws RDFException
Add a property to this resource.

A statement with this resource as the subject, p as the predicate and o as the object is added to the model associated with this resource.

Parameters:
p - The property to be added.
o - The value of the property to be added.
Returns:
This resource to allow cascading calls.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p)
                    throws RDFException
Determine whether this resource has any values for a given property.
Parameters:
p - The property sought.
Returns:
true if and only if this resource has at least one value for the property.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           boolean o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           long o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           char o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           float o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           double o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           java.lang.String o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           java.lang.String o,
                           java.lang.String l)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
l - The language of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           java.lang.Object o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

hasProperty

public boolean hasProperty(Property p,
                           RDFNode o)
                    throws RDFException
Test if this resource has a given property with a given value.
Parameters:
p - The property sought.
o - The value of the property sought.
Returns:
true if and only if this resource has property p with value o.
Throws:
RDFException - Generic RDF exception.

removeProperties

public Resource removeProperties()
                          throws RDFException
Delete all the properties for this resource from the associated model.
Returns:
This resource to permit cascading.
Throws:
RDFException - Generic RDF exception.

begin

public Resource begin()
               throws RDFException
Begin a transaction in the associated model.
Returns:
This resource to permit cascading.
Throws:
RDFException - Generic RDF exception.

abort

public Resource abort()
               throws RDFException
Abort the transaction in the associated model.
Returns:
This resource to permit cascading.
Throws:
RDFException - Generic RDF exception.

commit

public Resource commit()
                throws RDFException
Commit the transaction in the associated model.
Returns:
This resource to permit cascading.
Throws:
RDFException - Generic RDF exception.

getModel

public Model getModel()
Return the model associated with this resource.
Returns:
The model associated with this resource.


Copyright 2001 Hewlett-Packard. All Rights Reserved.