ontopoly.model
Class IdentityField

java.lang.Object
  ontopoly.model.Topic
      ontopoly.model.FieldDefinition
          ontopoly.model.IdentityField

public class IdentityField
extends FieldDefinition

Represents an identify field.

Field Summary

Fields inherited from class ontopoly.model.FieldDefinition

FIELD_TYPE_IDENTITY, FIELD_TYPE_NAME, FIELD_TYPE_OCCURRENCE, FIELD_TYPE_QUERY, FIELD_TYPE_ROLE

Constructor Summary

IdentityField(TopicIF topic, TopicMap tm)
Creates a new IdentityField object.

IdentityField(TopicIF topic, TopicMap tm, IdentityType identityType)

Method Summary

void	addValue(Topic topic, java.lang.Object _value, LifeCycleListener listener) Replaces a subject locator of or adds a subject identifier to a topic.
boolean	equals(java.lang.Object obj)
java.lang.String	getFieldName() Returns the name of the IdentityField object.
int	getFieldType()
int	getHeight() Returns the assigned height of the identity text field.
IdentityType	getIdentityType() Gets the identity type.
LocatorIF	getLocator()
java.util.Collection<? extends java.lang.Object>	getValues(Topic topic) Returns either the subject locator or every subject identifier associated with the topic.
int	getWidth() Returns the assigned width of the identity text field.
boolean	isItemIdentifier() True if this is the item identifier field type.
boolean	isSubjectIdentifier() True if this is the subject identifier field type.
boolean	isSubjectLocator() True if this is the subject locator field type.
void	removeValue(Topic topic, java.lang.Object _value, LifeCycleListener listener) Removes the subject locator or a subject identifier from a topic.

Methods inherited from class ontopoly.model.FieldDefinition

getCardinality, getFieldDefinition, getFieldDefinition, getFieldDefinition, getValidationType, getValueView, getViewModes, hashCode, setCardinality

Methods inherited from class ontopoly.model.Topic

addTopicType, copyCharacteristics, findDependentObjects, getDependentObjects, getFieldInstances, getFieldInstances, getId, getMostSpecificTopicType, getName, getTopicIF, getTopicMap, getTopicTypes, isAssociationType, isFieldDefinition, isInstanceOf, isInstanceOf, isNameType, isOccurrenceType, isOntologyTopic, isOntologyType, isPrivateSystemTopic, isPublicSystemTopic, isRoleType, isSystemTopic, isTopicMap, isTopicType, remove, removeTopicType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IdentityField

public IdentityField(TopicIF topic,
                     TopicMap tm)

Creates a new IdentityField object.

IdentityField

public IdentityField(TopicIF topic,
                     TopicMap tm,
                     IdentityType identityType)

Method Detail

getFieldType

public int getFieldType()

Specified by:

getFieldType in class FieldDefinition

Returns:

an int that identifies this fieldType

getFieldName

public java.lang.String getFieldName()

Returns the name of the IdentityField object.

Specified by:

getFieldName in class FieldDefinition

getLocator

public LocatorIF getLocator()

Specified by:

getLocator in class FieldDefinition

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class FieldDefinition

getIdentityType

public IdentityType getIdentityType()

Gets the identity type.

Returns:

the identity type.

isSubjectLocator

public boolean isSubjectLocator()

True if this is the subject locator field type.

isSubjectIdentifier

public boolean isSubjectIdentifier()

True if this is the subject identifier field type.

isItemIdentifier

public boolean isItemIdentifier()

True if this is the item identifier field type.

getValues

public java.util.Collection<? extends java.lang.Object> getValues(Topic topic)

Returns either the subject locator or every subject identifier associated with the topic.

Specified by:

getValues in class FieldDefinition

Parameters:

topic - topic from which the values is retrieved.

Returns:

A collection of LocatorIF objects.

addValue

public void addValue(Topic topic,
                     java.lang.Object _value,
                     LifeCycleListener listener)

Replaces a subject locator of or adds a subject identifier to a topic.

Specified by:

addValue in class FieldDefinition

Parameters:

_value - value which is going to be added to the topic.

removeValue

public void removeValue(Topic topic,
                        java.lang.Object _value,
                        LifeCycleListener listener)

Removes the subject locator or a subject identifier from a topic.

Specified by:

removeValue in class FieldDefinition

Parameters:

_value - value which is going to be removed from the topic.

getHeight

public int getHeight()

Returns the assigned height of the identity text field.

getWidth

public int getWidth()

Returns the assigned width of the identity text field.