org.meta2project.model
Interface OntObject

All Superinterfaces:
AnnotatedEntity, NamedEntity
All Known Implementing Classes:
BoxOntObject, DBOntObject, DBOntObjectBase, DebugOntObject

public interface OntObject
extends NamedEntity

A ontology object. При удалении объекта значения его свойств удаляются. Но если сам объект используется в качестве значения о-свойства, то возникнет исключение при удалении.

Author:
Anton Malykh

Field Summary
 
Fields inherited from interface org.meta2project.model.AnnotatedEntity
CASCADE, CASCADE_DELETE_VALUE, COMMENT, MAX_CARD, MIN_CARD, MODEL_URI, TITLE
 
Method Summary
 void addOntClass(OntClass ontClass)
          Задать принадлежность объекта к указанному классу.
 void addOPropertyValue(OProperty prop, int index, OntObject value)
          Добавить значение о-свойства в указанную позицию.
 void addOPropertyValue(OProperty prop, OntObject value)
          Добавить значение о-свойства.
 void addTPropertyString(TProperty prop, int index, java.lang.String value)
          Добавить значение т-свойства в виде строке в указанную позицию.
 void addTPropertyString(TProperty prop, java.lang.String value)
          Добавить значение т-свойства в виде строки.
 void delete()
          Удалить объект вместе с значениями его свойств.
 java.util.Collection<OntClass> getAllOntClasses()
          Получить список всех классов, которым принадлежит объект.
 java.util.Collection<OProperty> getAllOProperties()
          Получить все о-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта.
 java.util.Collection<TProperty> getAllTProperties()
          Получить все т-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта.
 java.util.Collection<OntClass> getOntClasses()
          Получить список классов, которым принадлежит объект напрямую.
 java.util.Collection<OProperty> getOProperties(java.lang.String name)
          Получить все о-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта и короткое имя которых равняется указанному
 OntObject getOPropertyValue(OProperty prop)
          Получить первое известное значение о-свойства.
 java.util.List<OntObject> getOPropertyValues(OProperty prop)
          Получить значения о-свойства.
 java.util.Collection<OntObject> getOwners(OProperty prop)
          Получить объекты, значениями о-свойства которых является данный объект.
 java.util.Collection<TProperty> getTProperties(java.lang.String name)
          Получить все т-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта и короткое имя которых равняется указанному.
 java.lang.String getTPropertyString(TProperty prop)
          Получить первое известное значение т-свойства как строку.
 java.util.List<java.lang.String> getTPropertyStrings(TProperty prop)
          Получить значения т-свойства как список строк.
 boolean isInstanceOf(OntClass cl)
          Проверить, является ли объект экземпляром класса (с учётом наследования).
 void removeAllValues()
          Удалить все значения т-свойств и о-свойств объекта.
 void removeOPropertyValue(OProperty prop, int index)
          Удалить значение о-свойства из указанной позиции
 void removeOValues(OProperty oprop)
          Удалить все значения о-свойства
 void removeTPropertyValue(TProperty prop, int index)
          Удалить значение т-свойства из указанной позиции.
 void removeTValues(TProperty tprop)
          Удалить все значения т-свойства
 
Methods inherited from interface org.meta2project.model.NamedEntity
getFullName, getName, getOntology, setName
 
Methods inherited from interface org.meta2project.model.AnnotatedEntity
getAnnotation, getAnnotationNames, putAnnotation
 

Method Detail

getOntClasses

java.util.Collection<OntClass> getOntClasses()
Получить список классов, которым принадлежит объект напрямую.

Returns:
список объектов OntClass

getAllOntClasses

java.util.Collection<OntClass> getAllOntClasses()
Получить список всех классов, которым принадлежит объект.

Returns:
список объектов OntClass

isInstanceOf

boolean isInstanceOf(OntClass cl)
Проверить, является ли объект экземпляром класса (с учётом наследования).

Parameters:
cl - класс
Returns:
true, если является экземпляром указанного класса

getAllTProperties

java.util.Collection<TProperty> getAllTProperties()
Получить все т-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта.

Returns:
список объектов класса TProperty
See Also:
TProperty

getAllOProperties

java.util.Collection<OProperty> getAllOProperties()
Получить все о-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта.

Returns:
список объектов класса OProperty
See Also:
OProperty

getTProperties

java.util.Collection<TProperty> getTProperties(java.lang.String name)
Получить все т-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта и короткое имя которых равняется указанному.

Parameters:
name - короткое имя
Returns:
список объектов класса TProperty
See Also:
TProperty

getOProperties

java.util.Collection<OProperty> getOProperties(java.lang.String name)
Получить все о-свойства (с учетом наследования), значения которых могут быть заданы для данного объекта и короткое имя которых равняется указанному

Parameters:
name - короткое имя
Returns:
список объектов класса OProperty
See Also:
OProperty

addOntClass

void addOntClass(OntClass ontClass)
Задать принадлежность объекта к указанному классу.

Parameters:
ontClass - класс.

getOPropertyValue

OntObject getOPropertyValue(OProperty prop)
Получить первое известное значение о-свойства. Если значений нет, то возвращается null.

Parameters:
prop - о-свойство
Returns:
значение объекта

getOPropertyValues

java.util.List<OntObject> getOPropertyValues(OProperty prop)
Получить значения о-свойства. Если значений нет, то возвращается пустой список.

Parameters:
prop - о-свойство
Returns:
список объектов класса OntObject

getOwners

java.util.Collection<OntObject> getOwners(OProperty prop)
Получить объекты, значениями о-свойства которых является данный объект. Если таких объектов нет, то возвращается пустой список.

Parameters:
prop - о-свойство
Returns:
список объектов класса OntObject

getTPropertyString

java.lang.String getTPropertyString(TProperty prop)
Получить первое известное значение т-свойства как строку. Если значения нет, то возвращается null;

Parameters:
prop - т-свойство
Returns:
значение или null, если значения нет

getTPropertyStrings

java.util.List<java.lang.String> getTPropertyStrings(TProperty prop)
Получить значения т-свойства как список строк. Если значений нет, то возвращается пустой список.

Parameters:
prop - т-свойство
Returns:
список объектов класса String.

addOPropertyValue

void addOPropertyValue(OProperty prop,
                       OntObject value)
Добавить значение о-свойства.

Parameters:
prop - о-свойство
value - объект-значение
Throws:
DomainException - ошибка домена
RangeException - ошибка ранга

addOPropertyValue

void addOPropertyValue(OProperty prop,
                       int index,
                       OntObject value)
Добавить значение о-свойства в указанную позицию.

Parameters:
prop - о-свойство
index - позиция
value - объект-значение
Throws:
DomainException - ошибка домена
RangeException - ошибка ранга

removeOPropertyValue

void removeOPropertyValue(OProperty prop,
                          int index)
Удалить значение о-свойства из указанной позиции

Parameters:
prop - о-свойство
index - позиция
Throws:
DomainException - ошибка домена

addTPropertyString

void addTPropertyString(TProperty prop,
                        java.lang.String value)
Добавить значение т-свойства в виде строки.

Parameters:
prop - т-свойство
value - значение
Throws:
RangeException - несоответствие области значений т-свойства

addTPropertyString

void addTPropertyString(TProperty prop,
                        int index,
                        java.lang.String value)
Добавить значение т-свойства в виде строке в указанную позицию.

Parameters:
prop - т-свойство
index - позиция
value - значение
Throws:
RangeException - несоответствие области значений т-свойства

removeTPropertyValue

void removeTPropertyValue(TProperty prop,
                          int index)
Удалить значение т-свойства из указанной позиции.

Parameters:
prop - т-свойство
index - позиция

delete

void delete()
Удалить объект вместе с значениями его свойств.

Specified by:
delete in interface NamedEntity

removeAllValues

void removeAllValues()
Удалить все значения т-свойств и о-свойств объекта.


removeTValues

void removeTValues(TProperty tprop)
Удалить все значения т-свойства

Parameters:
tprop - т-свойство

removeOValues

void removeOValues(OProperty oprop)
Удалить все значения о-свойства

Parameters:
oprop - о-свойство