org.ontoware.rdfreactor.runtime

Interface ReactorBase

All Superinterfaces:

ResourceEntity

All Known Implementing Classes:

ReactorBaseImpl

public interface ReactorBase
extends ResourceEntity

ReactorBase is the Interface which has to be implemented by all classes used to represent the RDFS or OWL ontology.

Author:

mvo

Method Summary

Modifier and Type	Method and Description
boolean	add(URI prop, Object o) Adds a statement (this, prop, o).
boolean	add(URI prop, Object o, int maxCard) Adds a statement (this, prop, o) if the number of statements matching (this, prop, x) is less then maxCard
Object	castTo(Class<?> targetType)
void	delete() remove all (this, rdf:type, ANY) statements
Object	get(URI prop, Class<?> returnType) This method is useful for functional properties.
Object[]	getAll(URI prop, Class<?> returnType) Get all predicates x of triples matching (this, prop, x)
Model	getModel()
URI	getRDFSClassURI()
boolean	in(Model model)
boolean	isInstanceof(Class<?> javaClass) Deprecated. not needed
boolean	isInstanceof(URI classURI)
boolean	remove(URI prop, Object o) Tries to remove a statement (this, prop, o).
boolean	remove(URI prop, Object o, int minCard) Tries to remove a statement (this, prop, o) if the number of statements matching (this, prop, x) in the model is less then minCard
boolean	removeAll(URI prop) Remove all values of this property (same as remove(this, prop, *)
void	set(URI prop, Object o) Removes all statements (this, prop, x) and set one anew: (this, prop, o).
void	setAll(URI prop, Object[] o) Removes all statements (this, prop, x) and sets anew: (this, prop, o[0]), (this, prop, o[1]), ...
void	setAll(URI prop, Object[] o, int maxCard) Removes all statements (this, prop, x) and sets anew: (this, prop, o[0]), (this, prop, o[1]), ...
boolean	update(URI prop, Object oldValue, Object newValue) Looks for a statement (this, prop, oldValue) and replaces it by a new statement (this, prop, newValue).

Methods inherited from interface org.ontoware.rdfreactor.runtime.ResourceEntity

getResource

Method Detail

getModel

Model getModel()

Returns:

the model for which this instance acts as a view

get

Object get(URI prop,
           Class<?> returnType)
    throws RDFDataException

This method is useful for functional properties.

Parameters:

prop -

Returns:

the first x in (this, prop, x) if such a statement is in the model. Null otherwise.

Throws:

RDFDataException - if multiple values are present

getAll

Object[] getAll(URI prop,
                Class<?> returnType)

Get all predicates x of triples matching (this, prop, x)

Parameters:

prop -

Returns:

an array of x with (this, prop, x) if such statements are in the model. Empty array otherwise.

set

void set(URI prop,
         Object o)

Removes all statements (this, prop, x) and set one anew: (this, prop, o).

Parameters:

prop -

o -

setAll

void setAll(URI prop,
            Object[] o)
     throws ModelRuntimeException

Removes all statements (this, prop, x) and sets anew: (this, prop, o[0]), (this, prop, o[1]), ...

Parameters:

prop -

o -

Throws:

Exception

ModelRuntimeException

setAll

void setAll(URI prop,
            Object[] o,
            int maxCard)
     throws ModelRuntimeException,
            CardinalityException

Removes all statements (this, prop, x) and sets anew: (this, prop, o[0]), (this, prop, o[1]), ... But only if the number of objects in o[] is less than or equal to maxCard

Parameters:

prop -

o -

maxCard - is the maximum number of triples allowed to match (this, prop, x)

Throws:

Exception

CardinalityException

ModelRuntimeException

update

boolean update(URI prop,
               Object oldValue,
               Object newValue)
        throws ModelRuntimeException

Looks for a statement (this, prop, oldValue) and replaces it by a new statement (this, prop, newValue). If the first cannot be found, false is returned, true otherwise.

Parameters:

prop -

oldValue -

newValue -

Returns:

true, if old value was found in the model

Throws:

Exception

ModelRuntimeException

add

boolean add(URI prop,
            Object o)
     throws ModelRuntimeException

Adds a statement (this, prop, o).

Parameters:

prop -

o -

Returns:

true if value was already in the model

Throws:

Exception

ModelRuntimeException

add

boolean add(URI prop,
            Object o,
            int maxCard)
     throws CardinalityException,
            ModelRuntimeException

Adds a statement (this, prop, o) if the number of statements matching (this, prop, x) is less then maxCard

Parameters:

property -

object -

maxCard, - number of occurences of (this, prop, x) allowed in the model

Returns:

true if value was already preset

Throws:

CardinalityException

ModelRuntimeException

remove

boolean remove(URI prop,
               Object o)

Tries to remove a statement (this, prop, o).

Parameters:

prop -

o -

Returns:

true if old value was found

remove

boolean remove(URI prop,
               Object o,
               int minCard)
        throws CardinalityException

Tries to remove a statement (this, prop, o) if the number of statements matching (this, prop, x) in the model is less then minCard

Parameters:

prop -

o -

minCard, - number of occurences of (this, prop, x) needed in the model

Returns:

true if value was found

Throws:

CardinalityException

removeAll

boolean removeAll(URI prop)

Remove all values of this property (same as remove(this, prop, *)

Parameters:

prop - the URI to be removed

Returns:

true if at least on value was found and removed

delete

void delete()

remove all (this, rdf:type, ANY) statements

getRDFSClassURI

URI getRDFSClassURI()

Returns:

the URI of the rdfs:Class, as which this resource is viewed

isInstanceof

boolean isInstanceof(URI classURI)
              throws ModelRuntimeException

Throws:

ModelRuntimeException

isInstanceof

@Deprecated
boolean isInstanceof(Class<?> javaClass)
                          throws ModelRuntimeException

Deprecated. not needed

Parameters:

javaClass -

Returns:

true iff the given Object is of type javaClass

Throws:

Exception

ModelRuntimeException

castTo

Object castTo(Class<?> targetType)

Parameters:

targetType - any java class that extends ReactorBase directly or indirectly

Returns:

a reference to a new object seeing this object as a 'targetType'

in

boolean in(Model model)

Parameters:

model - and RDG2GO model

Returns:

true, iff this resource is contained in any statement of the model