Sirius.server.localserver.object

Interface Object

All Superinterfaces:

Mapable, Serializable, StringConvertable, StringCreateable

All Known Subinterfaces:

MetaObject

All Known Implementing Classes:

BackreferencingCachehitMetaObject, DefaultMetaObject, DefaultObject, LightweightMetaObject, LightweightObject, NullMetaObject

public interface Object
extends Mapable, StringConvertable, StringCreateable, Serializable

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

srichter

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODIFIED modidifed meta object (to be updated).
static int	NEW new meta object (to be inserted).
static int	NO_STATUS status not set.
static int	TEMPLATE object template.
static int	TO_DELETE deleted meta object (to be deleted).

Method Summary

Modifier and Type	Method and Description
void	addAllAttributes(ObjectAttribute[] objectAttributes) adds all attributes to the Object.
void	addAttribute(ObjectAttribute anyAttribute) Fügt ein Attribut in die davor vorgesehenen AtrributVectoren ein.
Object	constructKey(Mapable m) Deprecated. UNUSED
Object	filter(User ug) liefert eine fuer ug sichtbare Attributierung.
void	forceStatus(int status) DOCUMENT ME!
Object	fromString(String objectRepresentation, Object mo) creates an Instance of this Object from a string representation.
ObjectAttribute[]	getAttribs() beschafft eine Arrayrprenstation aller Attribute des Object.
ObjectAttribute	getAttribute(String name) retrieves an Attributed referenced by its name Please note that this method retrieves the first attribute that matchtes if one needs all attributes matching he should use getAttributeByname().
ObjectAttribute	getAttributeByFieldName(String fieldname) Method from Hell liefert ein Attribut �ber den Fieldname Es wird davon ausgegangen, dass nur ObjectAttributes im getAttributes() sind.
Collection<ObjectAttribute>	getAttributeByName(String name, int maxResult) beschafft eine Collection welche alle Attribute enthält deren Schlüssel dem parameter name entsprechen.
LinkedHashMap<Object,ObjectAttribute>	getAttributes() getter for attribHash.
Collection<ObjectAttribute>	getAttributesByName(Collection names) beschafft eine Collection welche alle Attribute enthält deren Schlüssel dem parameter name entsprechen.
Collection<ObjectAttribute>	getAttributesByType(Class c) DOCUMENT ME!
Collection<ObjectAttribute>	getAttributesByType(Class c, int recursionDepth) DOCUMENT ME!
int	getClassID() getter for classID.
int	getID() getter for ID.
Object	getKey() key of the form classId.objectID.
FromStringCreator	getObjectCreator() DOCUMENT ME!
ObjectAttribute	getPrimaryKey() geter for primaryKey.
ObjectAttribute	getReferencingObjectAttribute() DOCUMENT ME!
int	getStatus() geter for status.
String	getStatusDebugString() DOCUMENT ME!
Collection<ObjectAttribute>	getTraversedAttributesByType(Class c) DOCUMENT ME!
boolean	isDummy() getter for dummy.
boolean	isPersistent() Getter for property persistent.
boolean	isStringCreateable() indicates whether fromString() can be called.
void	removeAttribute(ObjectAttribute anyAttribute) DOCUMENT ME!
void	setDummy(boolean dummy) setter for dummy.
void	setID(int objectID) DOCUMENT ME!
void	setPersistent(boolean persistent) Setter for property persistent.
void	setPrimaryKeysNull() DOCUMENT ME!
void	setReferencingObjectAttribute(ObjectAttribute referencingObjectAttribute) DOCUMENT ME!
void	setStatus(int status) setter for status.
void	setValuesNull() initializes all attributes with NULL.

Field Detail

MODIFIED

static final int MODIFIED

modidifed meta object (to be updated).

See Also:

Constant Field Values

NEW

static final int NEW

new meta object (to be inserted).

See Also:

Constant Field Values

NO_STATUS

static final int NO_STATUS

status not set.

See Also:

Constant Field Values

TEMPLATE

static final int TEMPLATE

object template.

See Also:

Constant Field Values

TO_DELETE

static final int TO_DELETE

deleted meta object (to be deleted).

See Also:

Constant Field Values

Method Detail

addAllAttributes

void addAllAttributes(ObjectAttribute[] objectAttributes)

adds all attributes to the Object.

Parameters:

objectAttributes - attributes to be added to the Object

addAttribute

void addAttribute(ObjectAttribute anyAttribute)

Fügt ein Attribut in die davor vorgesehenen AtrributVectoren ein.

Parameters:

anyAttribute - Objektattribute

See Also:

#longs, #dates, #doubles, #longs

constructKey

Object constructKey(Mapable m)

Deprecated. UNUSED

UNUSED.

Specified by:

constructKey in interface Mapable

Parameters:

m - UNUSED

Returns:

UNUSED

filter

Object filter(User ug)

liefert eine fuer ug sichtbare Attributierung.

Parameters:

ug - Benutzergruppe nach der gefiltert werden soll

Returns:

eine fuer UG massgeschneiderte Version des Objekts

fromString

Object fromString(String objectRepresentation,
                  Object mo)
           throws Exception

creates an Instance of this Object from a string representation.

fromString(o.toSting())=o should be valid however this cannot be true in all thinkable situations

Specified by:

fromString in interface StringCreateable

Parameters:

objectRepresentation - string represntation of this Object

mo - templet of an Object

Returns:

an instance of Object constucted by the objectCreator using the Stringreprsentation as input

Throws:

Exception - java.lang.Exception error during consturction of an Object

getAttribs

ObjectAttribute[] getAttribs()

beschafft eine Arrayrprenstation aller Attribute des Object.

Returns:

Alle Attribute des Objekts

See Also:

#longs

getAttribute

ObjectAttribute getAttribute(String name)

retrieves an Attributed referenced by its name Please note that this method retrieves the first attribute that matchtes if one needs all attributes matching he should use getAttributeByname().

Parameters:

name - Name des gewünschten Attributs

Returns:

das Attribut zu dem der Schlüssel passt

getAttributeByFieldName

ObjectAttribute getAttributeByFieldName(String fieldname)

Method from Hell liefert ein Attribut �ber den Fieldname Es wird davon ausgegangen, dass nur ObjectAttributes im getAttributes() sind.

Parameters:

fieldname - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributeByName

Collection<ObjectAttribute> getAttributeByName(String name,
                                               int maxResult)

beschafft eine Collection welche alle Attribute enthält deren Schlüssel dem parameter name entsprechen.

Parameters:

name - Name/Schlüssel des Attributes

maxResult - DOCUMENT ME!

Returns:

Collection mit allen attributen gleichen schlüssels == name

getAttributes

LinkedHashMap<Object,ObjectAttribute> getAttributes()

getter for attribHash.

Returns:

Hashtabel containing this objects attributes

getAttributesByName

Collection<ObjectAttribute> getAttributesByName(Collection names)

beschafft eine Collection welche alle Attribute enthält deren Schlüssel dem parameter name entsprechen.

Parameters:

names - Name/Schlüssel des Attributes

Returns:

Collection mit allen attributen gleichen schlüssels == name

getAttributesByType

Collection<ObjectAttribute> getAttributesByType(Class c,
                                                int recursionDepth)

DOCUMENT ME!

Parameters:

c - DOCUMENT ME!

recursionDepth - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributesByType

Collection<ObjectAttribute> getAttributesByType(Class c)

DOCUMENT ME!

Parameters:

c - DOCUMENT ME!

Returns:

DOCUMENT ME!

getClassID

int getClassID()

getter for classID.

Returns:

id der Klasse dieses Objekts

See Also:

#classID

getID

int getID()

getter for ID.

Returns:

eineutiger Schlüssel (innerhlab einer Klasse)

See Also:

#objectID

getKey

Object getKey()

key of the form classId.objectID.

Specified by:

getKey in interface Mapable

Returns:

eindeutiger Schlüssel innerhalb einer domain (i.d.R. objectID@classID)

getPrimaryKey

ObjectAttribute getPrimaryKey()

geter for primaryKey.

Returns:

this objects class tables primary key

getReferencingObjectAttribute

ObjectAttribute getReferencingObjectAttribute()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getStatus

int getStatus()

geter for status.

Returns:

staturs

getStatusDebugString

String getStatusDebugString()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getTraversedAttributesByType

Collection<ObjectAttribute> getTraversedAttributesByType(Class c)

DOCUMENT ME!

Parameters:

c - DOCUMENT ME!

Returns:

DOCUMENT ME!

isDummy

boolean isDummy()

getter for dummy.

Returns:

determines whether it is an artificial object

isPersistent

boolean isPersistent()

Getter for property persistent.

Returns:

Value of property persistent.

isStringCreateable

boolean isStringCreateable()

indicates whether fromString() can be called.

Specified by:

isStringCreateable in interface StringCreateable

Returns:

can be created from a string reprenstation of this object

removeAttribute

void removeAttribute(ObjectAttribute anyAttribute)

DOCUMENT ME!

Parameters:

anyAttribute - DOCUMENT ME!

setDummy

void setDummy(boolean dummy)

setter for dummy.

Parameters:

dummy - whether it is a dummy

setID

void setID(int objectID)

DOCUMENT ME!

Parameters:

objectID - DOCUMENT ME!

setPersistent

void setPersistent(boolean persistent)

Setter for property persistent.

Parameters:

persistent - New value of property persistent.

setPrimaryKeysNull

void setPrimaryKeysNull()

DOCUMENT ME!

setReferencingObjectAttribute

void setReferencingObjectAttribute(ObjectAttribute referencingObjectAttribute)

DOCUMENT ME!

Parameters:

referencingObjectAttribute - DOCUMENT ME!

setStatus

void setStatus(int status)

setter for status.

Parameters:

status - status

forceStatus

void forceStatus(int status)

DOCUMENT ME!

Parameters:

status - DOCUMENT ME!

setValuesNull

void setValuesNull()

initializes all attributes with NULL.

getObjectCreator

FromStringCreator getObjectCreator()

DOCUMENT ME!

Returns:

the objectCreator