kaos.core.csi
Interface OntPropertyDescription

public interface OntPropertyDescription

This interface contains methods allowing to create and investigate a description of an ontology property. $Revision: 1.7 $

Method Summary

void	addMultipleValues(java.util.Set<java.lang.String> values)
void	addPropertyToOntModel(kaos.ontology.util.SerializableOntModelImpl ontModel, java.lang.String instanceName) Add this property to the instance definition in the ontology model
void	addValue(java.lang.String value) Add the value to this property.
java.lang.String	getFirstValue() Get the first value of this property.
java.lang.String	getName() Get the name of this property.
java.util.Set<java.lang.String>	getNestedPropertyValues(java.lang.String nestedPropertyName) Locate the given property nested within one of the value descriptions for this property and return the set of values for that nested property.
java.lang.Object	getValueDescForValue(java.lang.String value) Get the optional description of the given property value.
java.util.Set<java.lang.String>	getValues() Get the values of this property.
void	removeAllValues() Clear the property value.
void	removeValue(java.lang.String value) Remove the property value.
void	removeValueDescForValue(java.lang.String value) Remove the optional description of the given property value.
void	setValue(java.lang.String value) Set the value to this property, if previous values exists they will be deleted
void	setValueDescForValue(java.lang.String value, java.lang.Object desc) Set the optional description of the given property value.

Method Detail

setValue

void setValue(java.lang.String value)

Set the value to this property, if previous values exists they will be deleted

Parameters:

value - String containing the value of the property.

addValue

void addValue(java.lang.String value)

Add the value to this property.

Parameters:

value - String containing the value of the property.

addMultipleValues

void addMultipleValues(java.util.Set<java.lang.String> values)

See Also:

kaos.core.csi.OntPropertyDescription#addValue(Set)

setValueDescForValue

void setValueDescForValue(java.lang.String value,
                          java.lang.Object desc)

Set the optional description of the given property value.

Parameters:

value - String containing the value of the property.

desc - Object containing the description of the value often it will be kaos.core.csi.OntInstanceDescription

getName

java.lang.String getName()

Get the name of this property.

Returns:

String containing the uri of the property.

getValues

java.util.Set<java.lang.String> getValues()

Get the values of this property.

Returns:

Set containing the value of the property.

getFirstValue

java.lang.String getFirstValue()

Get the first value of this property.

Returns:

first value of the property.

getNestedPropertyValues

java.util.Set<java.lang.String> getNestedPropertyValues(java.lang.String nestedPropertyName)

Locate the given property nested within one of the value descriptions for this property and return the set of values for that nested property.

Parameters:

nestedPropertyName -

Returns:

Set of String values for the nested property

getValueDescForValue

java.lang.Object getValueDescForValue(java.lang.String value)

Get the optional description of the given property value.

Parameters:

value - String containing the value of the property.

Returns:

Object containing the description of the value often it will be kaos.core.csi.OntInstanceDescription

removeValue

void removeValue(java.lang.String value)

Remove the property value.

Parameters:

value - String containing the value of the property.

removeAllValues

void removeAllValues()

Clear the property value.

removeValueDescForValue

void removeValueDescForValue(java.lang.String value)

Remove the optional description of the given property value.

Parameters:

value - String containing the value of the property.

addPropertyToOntModel

void addPropertyToOntModel(kaos.ontology.util.SerializableOntModelImpl ontModel,
                           java.lang.String instanceName)

Add this property to the instance definition in the ontology model

Parameters:

ontModel - ontology model to which the property is to be added

instanceName - name of the instance the property is to be added to