org.ontobox.box
Interface BoxWorker

All Known Implementing Classes:

BaseBoxWorker, FastBoxWorker

public interface BoxWorker

The worker to execute read actions. Write actions can be executed through the writer.

Author:

Anton Malykh

Method Summary

java.lang.String[]	annames(int e)
java.lang.String	anno(int e, java.lang.String name)
boolean[]	booleans(int tprop)
boolean[]	booleans(int object, int tprop)
int[]	classes(int e)
int[]	classesDirect(int e)
<T> T	clientDirect(BoxDirectClient<T> client)
void	close() Close and roll back uncommited changes if any
void	commit() Commit changes
java.util.Date[]	dateTimes(int tprop)
java.util.Date[]	dateTimes(int object, int tprop)
java.lang.Integer	domain(int e)
Entity	entity(int id) Get entity type
Entity	entity(java.lang.String name) Get entity type
java.lang.Integer	id(java.lang.String name) Get id by name
int[]	ints(int tprop)
int[]	ints(int object, int tprop)
boolean	isTransaction() Verify if transaction worker
java.lang.String	local(int entity) Get short/local name of entity
long[]	longs(int tprop)
long[]	longs(int object, int tprop)
java.lang.String	name(int id) Get name by id
java.lang.String	name(int ont, java.lang.String local) Generate full name for ontology and short/local name.
int[]	objects(int e)
int[]	objects(int object, int oprop)
int[]	objectsDirect(int e)
int[]	ontologies() Get all ontologies
int	ontology(int enitity) Get ontology of entity
int[]	oprops(int fn)
int[]	opropsDirect(int fn)
int[]	owners(int obj)
int[]	owners(int prop, int obj)
int[]	owners(int prop, java.lang.String value)
int[]	owners(java.lang.String value)
java.lang.Integer	range(int e)
int	resolve(java.lang.String name) Get entity id, throws exception if there is no such entity
int	resolve(java.lang.String name, Entity type) Get entity id, throws exception if there is no such entity or entity type is not expected
void	rollback() Roll back uncommited changes
java.lang.String[]	strings(int tprop)
java.lang.String[]	strings(int object, int tprop)
int[]	subclasses(int e)
int[]	subclassesDirect(int e)
int[]	tprops(int fn)
int[]	tpropsDirect(int fn)
int[]	types(int e)
BoxWriter	write() Get the writer for write actions

Method Detail

write

BoxWriter write()

Get the writer for write actions

Returns:

writer

name

java.lang.String name(int id)

Get name by id

Parameters:

id - entity id

Returns:

entity name, null if id is unknown

id

java.lang.Integer id(java.lang.String name)

Get id by name

Parameters:

name - entity name

Returns:

entity id, null if name is unknown

name

java.lang.String name(int ont,
                      java.lang.String local)

Generate full name for ontology and short/local name.

Parameters:

ont - ontology

local - short/local name (may be new for ontobase)

Returns:

full name

local

java.lang.String local(int entity)

Get short/local name of entity

Parameters:

entity - entity (but ontology)

Returns:

short/local name

Throws:

java.lang.RuntimeException - if there is no such entity

ontology

int ontology(int enitity)

Get ontology of entity

Parameters:

enitity - entity (but ontology)

Returns:

ontology

Throws:

java.lang.RuntimeException - if there is no such entity

entity

Entity entity(java.lang.String name)

Get entity type

Parameters:

name - entity name

Returns:

entity type, null if not found

See Also:

Entity

entity

Entity entity(int id)

Get entity type

Parameters:

id - entity id

Returns:

entity type, null if not found

See Also:

Entity

resolve

int resolve(java.lang.String name)

Get entity id, throws exception if there is no such entity

Parameters:

name - entity name

Returns:

entity id

Throws:

java.lang.RuntimeException - if there is no such entity

resolve

int resolve(java.lang.String name,
            Entity type)

Get entity id, throws exception if there is no such entity or entity type is not expected

Parameters:

name - entity name

type - expected entity type

Returns:

entity id

Throws:

java.lang.RuntimeException - if there is no such entity or entity type is not expected

ontologies

int[] ontologies()

Get all ontologies

Returns:

ontologies

objects

int[] objects(int e)

objectsDirect

int[] objectsDirect(int e)

classes

int[] classes(int e)

classesDirect

int[] classesDirect(int e)

subclasses

int[] subclasses(int e)

subclassesDirect

int[] subclassesDirect(int e)

types

int[] types(int e)

tprops

int[] tprops(int fn)

tpropsDirect

int[] tpropsDirect(int fn)

oprops

int[] oprops(int fn)

opropsDirect

int[] opropsDirect(int fn)

strings

java.lang.String[] strings(int tprop)

strings

java.lang.String[] strings(int object,
                           int tprop)

ints

int[] ints(int tprop)

ints

int[] ints(int object,
           int tprop)

longs

long[] longs(int tprop)

longs

long[] longs(int object,
             int tprop)

dateTimes

java.util.Date[] dateTimes(int tprop)

dateTimes

java.util.Date[] dateTimes(int object,
                           int tprop)

booleans

boolean[] booleans(int tprop)

booleans

boolean[] booleans(int object,
                   int tprop)

objects

int[] objects(int object,
              int oprop)

owners

int[] owners(java.lang.String value)

owners

int[] owners(int prop,
             java.lang.String value)

owners

int[] owners(int obj)

owners

int[] owners(int prop,
             int obj)

range

java.lang.Integer range(int e)

domain

java.lang.Integer domain(int e)

anno

java.lang.String anno(int e,
                      java.lang.String name)

annames

java.lang.String[] annames(int e)

isTransaction

boolean isTransaction()

Verify if transaction worker

Returns:

true if transaction worker

clientDirect

<T> T clientDirect(BoxDirectClient<T> client)

commit

void commit()

Commit changes

rollback

void rollback()

Roll back uncommited changes

close

void close()

Close and roll back uncommited changes if any