livespace.services.entities
Class InfoRepositoryEntity

java.lang.Object
  extended by dsto.dfc.databeans.AbstractDataObject
      extended by dsto.dfc.databeans.SimpleDataObject
          extended by dsto.dfc.databeans.FancyDataObject
              extended by livespace.services.Entity
                  extended by livespace.services.entities.InfoRepositoryEntity
All Implemented Interfaces:
IDataObject, IDataObjectChildListener, Cloneable

public class InfoRepositoryEntity
extends Entity

Represents a node within an information repository (i.e. a repository where documents and information etc. can be stored).

A node could be any part of the information repository, such as the root element of the info repository, some element below the root (i.e. a directory or folder) or the actual contents/data within the information repository (i.e. a document).

Author:
Steven Johnson Created on 13/01/2005, Vivian Nguyen

Field Summary
 EntityRegistry children
          A registry of the children information repository entities.
static String ENTITY_TYPE
           
 boolean ignoreRename
           
static String NODE_TYPE
          The name of the property representing the node type.
 String path
           
 EntityRegistry queries
           
 String url
          The URL from where the information repository element can be accessed.
 
Fields inherited from class livespace.services.Entity
container, id, lastTouched, name, unconfirmedUpdates
 
Fields inherited from class dsto.dfc.databeans.AbstractDataObject
listeners
 
Fields inherited from interface dsto.dfc.databeans.IDataObject
OVERRIDE, PERSISTENT, PERSISTENT_OVERRIDE, TRANSIENT, TRANSIENT_OVERRIDE
 
Constructor Summary
InfoRepositoryEntity()
           
InfoRepositoryEntity(String id)
           
InfoRepositoryEntity(String id, String name)
           
InfoRepositoryEntity(String id, String name, String url)
           
 
Method Summary
 String getType()
          The type of the object (eg "room", "light", "volume", etc).
 
Methods inherited from class livespace.services.Entity
create, createId, getElvin, getType, getTypeInfo, mutex, sameEntity, shallowClone, waitForProperty, waitForProperty, waitForProperty, waitForProperty
 
Methods inherited from class dsto.dfc.databeans.FancyDataObject
childPropertyChanged, getValue, isTransient, propertyIterator, setValue
 
Methods inherited from class dsto.dfc.databeans.SimpleDataObject
getFieldNames, setValue
 
Methods inherited from class dsto.dfc.databeans.AbstractDataObject
addFirstPropertyListener, addPropertyListener, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, firePropertyChangedEvent, getBeanValue, getBooleanValue, getBooleanValue, getCharValue, getCharValue, getDoubleValue, getDoubleValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getObjectValue, getPropertyListeners, getShortValue, getStringValue, registerValue, removePropertyListener, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, unregisterValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE
See Also:
Constant Field Values

NODE_TYPE

public static final String NODE_TYPE
The name of the property representing the node type.

See Also:
Constant Field Values

children

public EntityRegistry children
A registry of the children information repository entities.


queries

public EntityRegistry queries

url

public String url
The URL from where the information repository element can be accessed.


path

public String path

ignoreRename

public transient boolean ignoreRename
Constructor Detail

InfoRepositoryEntity

public InfoRepositoryEntity()

InfoRepositoryEntity

public InfoRepositoryEntity(String id)

InfoRepositoryEntity

public InfoRepositoryEntity(String id,
                            String name)

InfoRepositoryEntity

public InfoRepositoryEntity(String id,
                            String name,
                            String url)
Method Detail

getType

public String getType()
Description copied from class: Entity
The type of the object (eg "room", "light", "volume", etc). This must be unique to the entity class.

NOTE: it is also a good practice to provide a static field that defines the entity type on the class: eg

 public static final String ENTITY_TYPE = "room";
 

Specified by:
getType in class Entity
See Also:
Entity.getType()


Copyright © 2008 Commonwealth of Australia