de.tudresden.inf.lat.jcel.coreontology.datatype
Interface IntegerEntityManager

All Known Implementing Classes:
IntegerEntityManagerImpl

public interface IntegerEntityManager

An object implementing this interface manages entities and creates new identification numbers for auxiliary entities.

Author:
Julian Mendez

Field Summary
static Integer bottomClassId
           
static Integer bottomDataPropertyId
           
static Integer bottomObjectPropertyId
           
static Integer firstUsableIdentifier
           
static Integer topClassId
           
static Integer topDataPropertyId
           
static Integer topObjectPropertyId
           
 
Method Summary
 Integer createAnonymousEntity(IntegerEntityType type, boolean auxiliary)
          Creates a new entity of a certain type.
 Integer createNamedEntity(IntegerEntityType type, String name, boolean auxiliary)
          Creates a new entity of a certain type.
 Integer createOrGetClassIdForIndividual(Integer individual)
          Returns the class identifier corresponding to the given individual.
 Integer createOrGetInverseObjectPropertyOf(Integer propertyId)
          Returns the inverse object property of the given object property.
 Set<Integer> getAuxiliaryInverseObjectProperties()
          Returns the auxiliary inverse object properties.
 Integer getAuxiliaryNominal(Integer individual)
          This method gives the auxiliary nominal related to a specific individual.
 Set<Integer> getAuxiliaryNominals()
          Returns the set of auxiliary nominals.
 Set<Integer> getEntities(IntegerEntityType type, boolean auxiliary)
          Returns the set of identifiers of auxiliary entities of a certain type.
 Integer getIndividual(Integer auxNominal)
          This method gives the individual related to a specific auxiliary nominal.
 Set<Integer> getIndividuals()
          Returns the set of individuals.
 String getName(Integer identifier)
          Returns the name defined for a certain entity.
 IntegerEntityType getType(Integer identifier)
          Returns the entity type for the given identifier
 boolean isAuxiliary(Integer identifier)
          Tells whether the given identifier corresponds to an auxiliary entity.
 boolean proposeInverseObjectPropertyOf(Integer firstProperty, Integer secondProperty)
          Proposes the association of an object property to another object property as one the inverse object property of the other one.
 int size()
          Returns the number of created entities, either auxiliary or non-auxiliary.
 

Field Detail

bottomClassId

static final Integer bottomClassId

bottomDataPropertyId

static final Integer bottomDataPropertyId

bottomObjectPropertyId

static final Integer bottomObjectPropertyId

firstUsableIdentifier

static final Integer firstUsableIdentifier

topClassId

static final Integer topClassId

topDataPropertyId

static final Integer topDataPropertyId

topObjectPropertyId

static final Integer topObjectPropertyId
Method Detail

createAnonymousEntity

Integer createAnonymousEntity(IntegerEntityType type,
                              boolean auxiliary)
Creates a new entity of a certain type.

Parameters:
type - type of the entity
auxiliary - true if and only if the created entity is an auxiliary entity
Returns:
a new auxiliary entity of a certain type

createNamedEntity

Integer createNamedEntity(IntegerEntityType type,
                          String name,
                          boolean auxiliary)
Creates a new entity of a certain type.

Parameters:
type - type of the entity
auxiliary - true if and only if the created entity is an auxiliary entity
name - name for this entity
Returns:
a new auxiliary entity of a certain type

createOrGetClassIdForIndividual

Integer createOrGetClassIdForIndividual(Integer individual)
Returns the class identifier corresponding to the given individual. If that class does not exist, it creates a new auxiliary class.

Parameters:
individual - individual to get the class
Returns:
the class identifier for the given individual

createOrGetInverseObjectPropertyOf

Integer createOrGetInverseObjectPropertyOf(Integer propertyId)
                                           throws IndexOutOfBoundsException
Returns the inverse object property of the given object property. If this property does not exist, it creates a new auxiliary object property.

Parameters:
propertyId - property identifier to create an inverse object property
Returns:
the inverse object property of the given object property
Throws:
IndexOutOfBoundsException - if the property identifier is greater than the last auxiliary property created

getAuxiliaryInverseObjectProperties

Set<Integer> getAuxiliaryInverseObjectProperties()
Returns the auxiliary inverse object properties.

Returns:
the auxiliary inverse object properties

getAuxiliaryNominal

Integer getAuxiliaryNominal(Integer individual)
This method gives the auxiliary nominal related to a specific individual.

Parameters:
individual - the individual
Returns:
the requested class or null if the individual does not have any related auxiliary nominal.

getAuxiliaryNominals

Set<Integer> getAuxiliaryNominals()
Returns the set of auxiliary nominals.

Returns:
the set of auxiliary nominals

getEntities

Set<Integer> getEntities(IntegerEntityType type,
                         boolean auxiliary)
Returns the set of identifiers of auxiliary entities of a certain type.

Parameters:
type - type of the entity
auxiliary - true for auxiliary entities, false for non-auxiliary entities
Returns:
the set of identifiers of auxiliary entities of a certain type

getIndividual

Integer getIndividual(Integer auxNominal)
This method gives the individual related to a specific auxiliary nominal.

Parameters:
auxNominal - the auxiliary nominal
Returns:
the requested individual or null if the auxiliary nominal does not have any related individual.

getIndividuals

Set<Integer> getIndividuals()
Returns the set of individuals.

Returns:
the set of individuals

getName

String getName(Integer identifier)
Returns the name defined for a certain entity.

Parameters:
identifier - entity to get the name
Returns:
the name defined for a certain entity

getType

IntegerEntityType getType(Integer identifier)
Returns the entity type for the given identifier

Parameters:
identifier - entity identifier
Returns:
the entity type for the given identifier

isAuxiliary

boolean isAuxiliary(Integer identifier)
Tells whether the given identifier corresponds to an auxiliary entity.

Returns:
true if and only if the given identifier corresponds to an auxiliary entity

proposeInverseObjectPropertyOf

boolean proposeInverseObjectPropertyOf(Integer firstProperty,
                                       Integer secondProperty)
                                       throws IndexOutOfBoundsException
Proposes the association of an object property to another object property as one the inverse object property of the other one. This association is accepted if and only if none of both object properties has already another inverse object property.

Parameters:
firstProperty - an object property
secondProperty - an object property
Returns:
true if and only if the proposal was accepted
Throws:
IndexOutOfBoundsException

size

int size()
Returns the number of created entities, either auxiliary or non-auxiliary.

Returns:
the number of created entities, either auxiliary or non-auxiliary.


Copyright © 2012. All Rights Reserved.