nz.ac.waikato.mcennis.rat.graph.actor
Interface Actor

All Superinterfaces:

java.lang.Comparable, ParsedObject, java.io.Serializable

All Known Implementing Classes:

BasicUser, DBActor

public interface Actor
extends java.io.Serializable, ParsedObject, java.lang.Comparable

Actors are any entity (such as nouns). Also known as nodes. They have properties and participate in links (relations, arcs, edges).

Method Summary

void	add(Property prop) Add the given property to this user.
boolean	equals(java.lang.Object o)
java.lang.String	getID() Return the id (unique within its type)
java.lang.String	getMode() Returns the type (mode) of this actor
java.util.List<Property>	getProperty() Return an array of all properties associated with this actor.
Property	getProperty(java.lang.String ID) Return the property with the given value.
void	init(Properties properties)
Actor	prototype() Return a copy of this Actor that is equal by compareTo()
void	removeProperty(java.lang.String ID) Remove a given property from this actor
void	setID(java.lang.String id) Sets an id unique (which must be its type).
void	setMode(java.lang.String type) Set the type (mode) of this actor.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getID

java.lang.String getID()

Return the id (unique within its type)

Returns:

ID of this actor

setID

void setID(java.lang.String id)

Sets an id unique (which must be its type).

Parameters:

id - ID this actor should be set to

getProperty

java.util.List<Property> getProperty()

Return an array of all properties associated with this actor. Returns null if no properties are attached.

Returns:

array of properties

getProperty

Property getProperty(java.lang.String ID)

Return the property with the given value. Returns null if no properties are attached.

Parameters:

ID - key-name for the property.

Returns:

Property object having this key or null

removeProperty

void removeProperty(java.lang.String ID)

Remove a given property from this actor

Parameters:

ID - key-name of property to remove.

add

void add(Property prop)

Add the given property to this user. If a property with this name already exists, it is replaced by this property.

Parameters:

prop - property to be added

setMode

void setMode(java.lang.String type)

Set the type (mode) of this actor. User ID's must be unique within a type.

Parameters:

type - new type (mode) of this actor

getMode

java.lang.String getMode()

Returns the type (mode) of this actor

Returns:

type (mode) of this actor

prototype

Actor prototype()

Return a copy of this Actor that is equal by compareTo()

Returns:

new duplicate Actor

equals

boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

init

void init(Properties properties)