net.ontopia.topicmaps.impl.rdbms
Class AssociationRole

java.lang.Object
  net.ontopia.persistence.proxy.AbstractRWPersistent
      net.ontopia.topicmaps.impl.rdbms.TMObject
          net.ontopia.topicmaps.impl.rdbms.AssociationRole

All Implemented Interfaces:

PersistentIF, AssociationRoleIF, ReifiableIF, TMObjectIF, TypedIF

public class AssociationRole
extends TMObject
implements AssociationRoleIF

INTERNAL: The rdbms association role implementation.

Field Summary

static String	CLASS_INDICATOR
protected static String[]	fields
protected static int	LF_association
protected static int	LF_player
protected static int	LF_reifier
protected static int	LF_sources
protected static int	LF_topicmap
protected static int	LF_type

Fields inherited from class net.ontopia.persistence.proxy.AbstractRWPersistent

id, MASKS, txn, values

Fields inherited from interface net.ontopia.topicmaps.core.AssociationRoleIF

EVENT_ADDED, EVENT_REMOVED, EVENT_SET_PLAYER, EVENT_SET_TYPE

Fields inherited from interface net.ontopia.topicmaps.core.ReifiableIF

EVENT_SET_REIFIER

Fields inherited from interface net.ontopia.topicmaps.core.TMObjectIF

EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER

Constructor Summary

AssociationRole()

AssociationRole(TransactionIF txn)

Method Summary

int	_p_getFieldCount()
void	_p_setTransaction(TransactionIF txn) INTERNAL: Sets the transaction that is responible for managing the object.
void	detach()
AssociationIF	getAssociation() PUBLIC: Gets the association to which this association role belongs.
String	getClassIndicator() INTERNAL: Returns the token that can be used to indicate the class of this instance.
String	getObjectId() PUBLIC: Gets the id of this object.
TopicIF	getPlayer() PUBLIC: Gets the topic that plays this association role (this member of the association).
TopicIF	getReifier() PUBLIC: Returns the topic that reifies this object.
TopicIF	getType() PUBLIC: Gets the type that this object is an instance of.
void	remove() PUBLIC: Removes the object from its parent.
void	setPlayer(TopicIF player) PUBLIC: Sets the topic that plays this association role.
void	setReifier(TopicIF _reifier) PUBLIC: Sets the reifier of this object.
void	setType(TopicIF type) PUBLIC: Sets the type that this object is an instance of.
String	toString()

Methods inherited from class net.ontopia.topicmaps.impl.rdbms.TMObject

addItemIdentifier, fireEvent, getItemIdentifiers, getTopicMap, isReadOnly, removeItemIdentifier, transactionChanged

Methods inherited from class net.ontopia.persistence.proxy.AbstractRWPersistent

_p_getIdentity, _p_getTransaction, _p_getType, _p_setIdentity, _p_toString, clearAll, detachCollectionField, detachField, executeQuery, getValue, isDeleted, isDirty, isDirty, isDirtyFlushed, isDirtyFlushed, isInDatabase, isLoaded, isNewObject, isPersistent, isTransient, loadCollectionField, loadField, loadFieldNoCheck, loadValue, nextDirty, nextDirty, nextDirtyFlushed, nextDirtyFlushed, setDeleted, setDirty, setDirtyFlushed, setInDatabase, setNewObject, setPersistent, setValue, unsetValue, valueAdded, valueChanged, valueRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF

addItemIdentifier, getItemIdentifiers, getTopicMap, isReadOnly, removeItemIdentifier

Field Detail

LF_sources

protected static final int LF_sources

See Also:

Constant Field Values

LF_topicmap

protected static final int LF_topicmap

See Also:

Constant Field Values

LF_association

protected static final int LF_association

See Also:

Constant Field Values

LF_type

protected static final int LF_type

See Also:

Constant Field Values

LF_player

protected static final int LF_player

See Also:

Constant Field Values

LF_reifier

protected static final int LF_reifier

See Also:

Constant Field Values

fields

protected static final String[] fields

CLASS_INDICATOR

public static final String CLASS_INDICATOR

See Also:

Constant Field Values

Constructor Detail

AssociationRole

public AssociationRole()

AssociationRole

public AssociationRole(TransactionIF txn)

Method Detail

detach

public void detach()

Specified by:

detach in interface PersistentIF

Specified by:

detach in class AbstractRWPersistent

_p_setTransaction

public void _p_setTransaction(TransactionIF txn)

Description copied from interface: PersistentIF

INTERNAL: Sets the transaction that is responible for managing the object.

Specified by:

_p_setTransaction in interface PersistentIF

Overrides:

_p_setTransaction in class AbstractRWPersistent

_p_getFieldCount

public int _p_getFieldCount()

Specified by:

_p_getFieldCount in interface PersistentIF

getClassIndicator

public String getClassIndicator()

Description copied from class: TMObject

INTERNAL: Returns the token that can be used to indicate the class of this instance. This indicator is currently only used by source locators.

Specified by:

getClassIndicator in class TMObject

getObjectId

public String getObjectId()

Description copied from interface: TMObjectIF

PUBLIC: Gets the id of this object. The object id is part of the topic map id space, and must be unique. The object id is not significant (or unique) outside the current topic map. The object id is immutable. The object id is thus stable through this object's lifetime.

Specified by:

getObjectId in interface TMObjectIF

Specified by:

getObjectId in class TMObject

Returns:

string which is this object's id.

getAssociation

public AssociationIF getAssociation()

Description copied from interface: AssociationRoleIF

PUBLIC: Gets the association to which this association role belongs.

Specified by:

getAssociation in interface AssociationRoleIF

Returns:

The association to which this association role belongs; an object implementing AssociationIF.

getPlayer

public TopicIF getPlayer()

Description copied from interface: AssociationRoleIF

PUBLIC: Gets the topic that plays this association role (this member of the association).

Specified by:

getPlayer in interface AssociationRoleIF

Returns:

The topic (member) which plays this role in the association.

setPlayer

public void setPlayer(TopicIF player)

Description copied from interface: AssociationRoleIF

PUBLIC: Sets the topic that plays this association role. Note that this has the side-effect of removing the role from its current player, if any, and inserting it on the new player, if any.

Specified by:

setPlayer in interface AssociationRoleIF

Parameters:

player - The topic (member) which plays this role in the association. Can be null; if null, then the effect is that there is no player of this role in this association.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getType

public TopicIF getType()

Description copied from interface: TypedIF

PUBLIC: Gets the type that this object is an instance of.

Specified by:

getType in interface TypedIF

Returns:

The type of this object; an object implementing TopicIF.

setType

public void setType(TopicIF type)

Description copied from interface: TypedIF

PUBLIC: Sets the type that this object is an instance of.

Specified by:

setType in interface TypedIF

Parameters:

type - The type for this object; an object implementing TopicIF.

getReifier

public TopicIF getReifier()

Description copied from interface: ReifiableIF

PUBLIC: Returns the topic that reifies this object.

Specified by:

getReifier in interface ReifiableIF

setReifier

public void setReifier(TopicIF _reifier)

Description copied from interface: ReifiableIF

PUBLIC: Sets the reifier of this object.

Specified by:

setReifier in interface ReifiableIF

toString

public String toString()

Overrides:

toString in class Object