Sirius.server.middleware.types

Class LightweightMetaObject

java.lang.Object

Sirius.server.middleware.types.LightweightMetaObject

All Implemented Interfaces:

StringCreateable, StringConvertable, de.cismet.connectioncontext.ConnectionContextProvider, de.cismet.connectioncontext.ConnectionContextStore, Serializable, Comparable<LightweightMetaObject>, Object, MetaObject, Editable, Groupable, Mapable, Renderable

public final class LightweightMetaObject
extends Object
implements MetaObject, Comparable<LightweightMetaObject>, de.cismet.connectioncontext.ConnectionContextStore

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

srichter

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_INVALIDATION_MESSAGE

Fields inherited from interface Sirius.server.localserver.object.Object

MODIFIED, NEW, NO_STATUS, TEMPLATE, TO_DELETE

Constructor Summary

Constructors

Constructor and Description
LightweightMetaObject(int classID, int objectID, String domain, User user) Creates a new LightweightMetaObject object.
LightweightMetaObject(int classID, int objectID, String domain, User user, Map<String,Object> attributesMap) Creates a new LightweightMetaObject object.
LightweightMetaObject(int classID, int objectID, String domain, User user, Map<String,Object> attributesMap, AbstractAttributeRepresentationFormater formater) Creates a new LightweightMetaObject object.

Method Summary

Modifier and Type	Method and Description
void	addAllAttributes(ObjectAttribute[] objectAttributes) DOCUMENT ME!
void	addAttribute(ObjectAttribute anyAttribute) DOCUMENT ME!
boolean	alreadyFetched() DOCUMENT ME!
static void	clearCache() DOCUMENT ME!
int	compareTo(LightweightMetaObject o) DOCUMENT ME!
Object	constructKey(Mapable m) DOCUMENT ME!
boolean	equals(Object obj)
Object	filter(User u) DOCUMENT ME!
void	forceStatus(int status) DOCUMENT ME!
Object	fromString(String objectRepresentation, Object o) Deprecated.
HashMap	getAllClasses() DOCUMENT ME!
ObjectAttribute[]	getAttribs() DOCUMENT ME!
ObjectAttribute	getAttribute(String name) DOCUMENT ME!
ObjectAttribute	getAttributeByFieldName(String fieldname) DOCUMENT ME!
Collection<ObjectAttribute>	getAttributeByName(String name, int maxResult) DOCUMENT ME!
LinkedHashMap<Object,ObjectAttribute>	getAttributes() DOCUMENT ME!
Collection<ObjectAttribute>	getAttributesByName(Collection names) DOCUMENT ME!
Collection<ObjectAttribute>	getAttributesByType(Class c) DOCUMENT ME!
Collection<ObjectAttribute>	getAttributesByType(Class c, int recursionDepth) DOCUMENT ME!
CidsBean	getBean() DOCUMENT ME!
int	getClassID() DOCUMENT ME!
String	getClassKey() getter for classKey.
String	getComplexEditor() getter for complex editor.
de.cismet.connectioncontext.ConnectionContext	getConnectionContext()
String	getDebugString() DOCUMENT ME!
String	getDescription() getter for description.
String	getDomain() getter for domain.
String	getEditor() Getter for property editor.
String	getGroup() getter for grouping criterion in this case the domain (in the sense of the group by clause in SQL).
int	getId() DOCUMENT ME!
int	getID() DOCUMENT ME!
Object	getKey() DOCUMENT ME!
static String	getKeyForCache(String domain, int classID, int objectID) DOCUMENT ME!
Set<String>	getKnownAttributeNames() DOCUMENT ME!
org.apache.log4j.Logger	getLogger() DOCUMENT ME!
Object	getLWAttribute(String aName) DOCUMENT ME!
MetaClass	getMetaClass() DOCUMENT ME!
MetaService	getMetaService() DOCUMENT ME!
String	getName() getter for name.
FromStringCreator	getObjectCreator() DOCUMENT ME!
int	getObjectID() DOCUMENT ME!
ObjectAttribute	getPrimaryKey() DOCUMENT ME!
String	getPropertyString() DOCUMENT ME!
MetaObject	getRealMetaObject() Lazy loads for the real MetaObject if needed, the returns it.
ObjectAttribute	getReferencingObjectAttribute() DOCUMENT ME!
String	getRenderer() getter for renderer.
String	getSimpleEditor() getter for simple editor.
int	getStatus() DOCUMENT ME!
String	getStatusDebugString() DOCUMENT ME!
Collection<ObjectAttribute>	getTraversedAttributesByType(Class c) DOCUMENT ME!
Collection<String>	getURLs(Collection classKeys) DOCUMENT ME!
Collection<String>	getURLsByName(Collection classKeys, Collection urlNames) DOCUMENT ME!
User	getUser() DOCUMENT ME!
int	hashCode()
boolean	hasObjectReadPermission(User user) DOCUMENT ME!
boolean	hasObjectWritePermission(User user) DOCUMENT ME!
void	initWithConnectionContext(de.cismet.connectioncontext.ConnectionContext connectionContext)
static boolean	invalidateCacheFor(String domain, int classId, int objectId) DOCUMENT ME!
boolean	isChanged() Getter for property changed.
boolean	isDummy() DOCUMENT ME!
boolean	isPersistent() DOCUMENT ME!
boolean	isStringCreateable() DOCUMENT ME!
boolean	propertyEquals(MetaObject tester) DOCUMENT ME!
void	removeAttribute(ObjectAttribute anyAttribute) DOCUMENT ME!
void	setAllClasses() DOCUMENT ME!
void	setAllClasses(HashMap classes) DOCUMENT ME!
void	setAllStatus(int status) sets the same status for all Objects in the hirarchy recursively.
void	setArrayKey2PrimaryKey() DOCUMENT ME!
void	setChanged(boolean changed) Setter for property changed.
void	setDummy(boolean dummy) DOCUMENT ME!
void	setEditor(String editor) Setter for property editor.
void	setFormater(AbstractAttributeRepresentationFormater formater) DOCUMENT ME!
void	setID(int objectID) DOCUMENT ME!
void	setMetaClass(MetaClass metaClass) DOCUMENT ME!
void	setMetaService(MetaService metaService) DOCUMENT ME!
void	setPersistent(boolean persistent) DOCUMENT ME!
boolean	setPrimaryKey(Object key) setter for the primary key sets the value of the attribute being primary key.
void	setPrimaryKeysNull() DOCUMENT ME!
void	setReferencingObjectAttribute(ObjectAttribute referencingObjectAttribute) DOCUMENT ME!
void	setRenderer(String renderer) Setter for property renderer.
void	setStatus(int status) DOCUMENT ME!
void	setValuesNull() DOCUMENT ME!
String	toString()
String	toString(HashMap classes) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_INVALIDATION_MESSAGE

public static final String CACHE_INVALIDATION_MESSAGE

See Also:

Constant Field Values

Constructor Detail

LightweightMetaObject

public LightweightMetaObject(int classID,
                             int objectID,
                             String domain,
                             User user)

Creates a new LightweightMetaObject object.

Parameters:

classID - DOCUMENT ME!

objectID - DOCUMENT ME!

domain - DOCUMENT ME!

user - DOCUMENT ME!

LightweightMetaObject

public LightweightMetaObject(int classID,
                             int objectID,
                             String domain,
                             User user,
                             Map<String,Object> attributesMap)

Creates a new LightweightMetaObject object.

Parameters:

classID - DOCUMENT ME!

objectID - DOCUMENT ME!

domain - DOCUMENT ME!

user - DOCUMENT ME!

attributesMap - DOCUMENT ME!

LightweightMetaObject

public LightweightMetaObject(int classID,
                             int objectID,
                             String domain,
                             User user,
                             Map<String,Object> attributesMap,
                             AbstractAttributeRepresentationFormater formater)

Creates a new LightweightMetaObject object.

Parameters:

classID - DOCUMENT ME!

objectID - DOCUMENT ME!

domain - DOCUMENT ME!

user - DOCUMENT ME!

attributesMap - DOCUMENT ME!

formater - DOCUMENT ME!

Method Detail

getAllClasses

public HashMap getAllClasses()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getAllClasses in interface MetaObject

Returns:

DOCUMENT ME!

getBean

public CidsBean getBean()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getBean in interface MetaObject

Returns:

DOCUMENT ME!

getComplexEditor

public String getComplexEditor()

Description copied from interface: MetaObject

getter for complex editor.

Specified by:

getComplexEditor in interface MetaObject

Specified by:

getComplexEditor in interface Editable

Returns:

complex editor

getDebugString

public String getDebugString()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getDebugString in interface MetaObject

Returns:

DOCUMENT ME!

getDescription

public String getDescription()

Description copied from interface: MetaObject

getter for description.

Specified by:

getDescription in interface MetaObject

Returns:

description

getEditor

public String getEditor()

Description copied from interface: MetaObject

Getter for property editor.

Specified by:

getEditor in interface MetaObject

Returns:

Value of property editor.

getGroup

public String getGroup()

Description copied from interface: MetaObject

getter for grouping criterion in this case the domain (in the sense of the group by clause in SQL).

Specified by:

getGroup in interface MetaObject

Specified by:

getGroup in interface Groupable

Returns:

grouping criterion

getLogger

public org.apache.log4j.Logger getLogger()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getLogger in interface MetaObject

Returns:

DOCUMENT ME!

getMetaClass

public MetaClass getMetaClass()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getMetaClass in interface MetaObject

Returns:

DOCUMENT ME!

getName

public String getName()

Description copied from interface: MetaObject

getter for name.

Specified by:

getName in interface MetaObject

Returns:

name

getPropertyString

public String getPropertyString()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getPropertyString in interface MetaObject

Returns:

DOCUMENT ME!

getRenderer

public String getRenderer()

Description copied from interface: MetaObject

getter for renderer.

Specified by:

getRenderer in interface MetaObject

Specified by:

getRenderer in interface Renderable

Returns:

renderer

getSimpleEditor

public String getSimpleEditor()

Description copied from interface: MetaObject

getter for simple editor.

Specified by:

getSimpleEditor in interface MetaObject

Specified by:

getSimpleEditor in interface Editable

Returns:

siomple editor

getURLs

public Collection<String> getURLs(Collection classKeys)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getURLs in interface MetaObject

Parameters:

classKeys - DOCUMENT ME!

Returns:

DOCUMENT ME!

getURLsByName

public Collection<String> getURLsByName(Collection classKeys,
                                        Collection urlNames)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

getURLsByName in interface MetaObject

Parameters:

classKeys - DOCUMENT ME!

urlNames - DOCUMENT ME!

Returns:

DOCUMENT ME!

isChanged

public boolean isChanged()

Description copied from interface: MetaObject

Getter for property changed.

Specified by:

isChanged in interface MetaObject

Returns:

Value of property changed.

propertyEquals

public boolean propertyEquals(MetaObject tester)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

propertyEquals in interface MetaObject

Parameters:

tester - DOCUMENT ME!

Returns:

DOCUMENT ME!

setAllClasses

public void setAllClasses(HashMap classes)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

setAllClasses in interface MetaObject

Parameters:

classes - DOCUMENT ME!

setAllClasses

public void setAllClasses()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

setAllClasses in interface MetaObject

setAllStatus

public void setAllStatus(int status)

Description copied from interface: MetaObject

sets the same status for all Objects in the hirarchy recursively.

Specified by:

setAllStatus in interface MetaObject

Parameters:

status - DOCUMENT ME!

setArrayKey2PrimaryKey

public void setArrayKey2PrimaryKey()

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

setArrayKey2PrimaryKey in interface MetaObject

setChanged

public void setChanged(boolean changed)

Description copied from interface: MetaObject

Setter for property changed.

Specified by:

setChanged in interface MetaObject

Parameters:

changed - New value of property changed.

setEditor

public void setEditor(String editor)

Description copied from interface: MetaObject

Setter for property editor.

Specified by:

setEditor in interface MetaObject

Parameters:

editor - New value of property editor.

setMetaClass

public void setMetaClass(MetaClass metaClass)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

setMetaClass in interface MetaObject

Parameters:

metaClass - DOCUMENT ME!

setPrimaryKey

public boolean setPrimaryKey(Object key)

Description copied from interface: MetaObject

setter for the primary key sets the value of the attribute being primary key.

Specified by:

setPrimaryKey in interface MetaObject

Parameters:

key - value of the key

Returns:

whether a primary key was found and its value set

setRenderer

public void setRenderer(String renderer)

Description copied from interface: MetaObject

Setter for property renderer.

Specified by:

setRenderer in interface MetaObject

Parameters:

renderer - New value of property renderer.

toString

public String toString(HashMap classes)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

toString in interface MetaObject

Parameters:

classes - DOCUMENT ME!

Returns:

DOCUMENT ME!

addAllAttributes

public void addAllAttributes(ObjectAttribute[] objectAttributes)

DOCUMENT ME!

Specified by:

addAllAttributes in interface Object

Parameters:

objectAttributes - DOCUMENT ME!

addAttribute

public void addAttribute(ObjectAttribute anyAttribute)

DOCUMENT ME!

Specified by:

addAttribute in interface Object

Parameters:

anyAttribute - DOCUMENT ME!

See Also:

#longs, #dates, #doubles, #longs

constructKey

public Object constructKey(Mapable m)

DOCUMENT ME!

Specified by:

constructKey in interface Object

Specified by:

constructKey in interface Mapable

Parameters:

m - DOCUMENT ME!

Returns:

DOCUMENT ME!

filter

public Object filter(User u)

DOCUMENT ME!

Specified by:

filter in interface Object

Parameters:

u - DOCUMENT ME!

Returns:

DOCUMENT ME!

fromString

@Deprecated
public Object fromString(String objectRepresentation,
                                     Object o)
                              throws Exception

Deprecated.

DOCUMENT ME!

Specified by:

fromString in interface StringCreateable

Specified by:

fromString in interface Object

Parameters:

objectRepresentation - DOCUMENT ME!

o - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

getAttribs

public ObjectAttribute[] getAttribs()

DOCUMENT ME!

Specified by:

getAttribs in interface Object

Returns:

DOCUMENT ME!

See Also:

#longs

getAttribute

public ObjectAttribute getAttribute(String name)

DOCUMENT ME!

Specified by:

getAttribute in interface Object

Parameters:

name - key DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributeByFieldName

public ObjectAttribute getAttributeByFieldName(String fieldname)

DOCUMENT ME!

Specified by:

getAttributeByFieldName in interface Object

Parameters:

fieldname - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributeByName

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

DOCUMENT ME!

Specified by:

getAttributeByName in interface Object

Parameters:

name - DOCUMENT ME!

maxResult - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributes

public LinkedHashMap<Object,ObjectAttribute> getAttributes()

DOCUMENT ME!

Specified by:

getAttributes in interface Object

Returns:

DOCUMENT ME!

getAttributesByName

public Collection<ObjectAttribute> getAttributesByName(Collection names)

DOCUMENT ME!

Specified by:

getAttributesByName in interface Object

Parameters:

names - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributesByType

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

DOCUMENT ME!

Specified by:

getAttributesByType in interface Object

Parameters:

c - DOCUMENT ME!

recursionDepth - DOCUMENT ME!

Returns:

DOCUMENT ME!

getAttributesByType

public Collection<ObjectAttribute> getAttributesByType(Class c)

DOCUMENT ME!

Specified by:

getAttributesByType in interface Object

Parameters:

c - DOCUMENT ME!

Returns:

DOCUMENT ME!

getKey

public Object getKey()

DOCUMENT ME!

Specified by:

getKey in interface Object

Specified by:

getKey in interface Mapable

Returns:

DOCUMENT ME!

getPrimaryKey

public ObjectAttribute getPrimaryKey()

DOCUMENT ME!

Specified by:

getPrimaryKey in interface Object

Returns:

DOCUMENT ME!

getReferencingObjectAttribute

public ObjectAttribute getReferencingObjectAttribute()

DOCUMENT ME!

Specified by:

getReferencingObjectAttribute in interface Object

Returns:

DOCUMENT ME!

getStatus

public int getStatus()

DOCUMENT ME!

Specified by:

getStatus in interface Object

Returns:

DOCUMENT ME!

getStatusDebugString

public String getStatusDebugString()

DOCUMENT ME!

Specified by:

getStatusDebugString in interface Object

Returns:

DOCUMENT ME!

getTraversedAttributesByType

public Collection<ObjectAttribute> getTraversedAttributesByType(Class c)

DOCUMENT ME!

Specified by:

getTraversedAttributesByType in interface Object

Parameters:

c - DOCUMENT ME!

Returns:

DOCUMENT ME!

isDummy

public boolean isDummy()

DOCUMENT ME!

Specified by:

isDummy in interface Object

Returns:

false, because a LightweightMetaObject cannot be a dummy

isPersistent

public boolean isPersistent()

DOCUMENT ME!

Specified by:

isPersistent in interface Object

Returns:

DOCUMENT ME!

isStringCreateable

public boolean isStringCreateable()

DOCUMENT ME!

Specified by:

isStringCreateable in interface StringCreateable

Specified by:

isStringCreateable in interface Object

Returns:

DOCUMENT ME!

removeAttribute

public void removeAttribute(ObjectAttribute anyAttribute)

DOCUMENT ME!

Specified by:

removeAttribute in interface Object

Parameters:

anyAttribute - DOCUMENT ME!

setDummy

public void setDummy(boolean dummy)

DOCUMENT ME!

Specified by:

setDummy in interface Object

Parameters:

dummy - true will be ignored, because a LightweightMetaObject cannot be a dummy

setPersistent

public void setPersistent(boolean persistent)

DOCUMENT ME!

Specified by:

setPersistent in interface Object

Parameters:

persistent - DOCUMENT ME!

setPrimaryKeysNull

public void setPrimaryKeysNull()

DOCUMENT ME!

Specified by:

setPrimaryKeysNull in interface Object

setReferencingObjectAttribute

public void setReferencingObjectAttribute(ObjectAttribute referencingObjectAttribute)

DOCUMENT ME!

Specified by:

setReferencingObjectAttribute in interface Object

Parameters:

referencingObjectAttribute - DOCUMENT ME!

setStatus

public void setStatus(int status)

DOCUMENT ME!

Specified by:

setStatus in interface Object

Parameters:

status - DOCUMENT ME!

forceStatus

public void forceStatus(int status)

Description copied from interface: Object

DOCUMENT ME!

Specified by:

forceStatus in interface Object

Parameters:

status - DOCUMENT ME!

setValuesNull

public void setValuesNull()

DOCUMENT ME!

Specified by:

setValuesNull in interface Object

getObjectCreator

public FromStringCreator getObjectCreator()

DOCUMENT ME!

Specified by:

getObjectCreator in interface Object

Returns:

DOCUMENT ME!

setFormater

public void setFormater(AbstractAttributeRepresentationFormater formater)

DOCUMENT ME!

Parameters:

formater - DOCUMENT ME!

getLWAttribute

public Object getLWAttribute(String aName)

DOCUMENT ME!

Parameters:

aName - DOCUMENT ME!

Returns:

DOCUMENT ME!

getKnownAttributeNames

public Set<String> getKnownAttributeNames()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getKeyForCache

public static String getKeyForCache(String domain,
                                    int classID,
                                    int objectID)

DOCUMENT ME!

Parameters:

domain - DOCUMENT ME!

classID - DOCUMENT ME!

objectID - DOCUMENT ME!

Returns:

DOCUMENT ME!

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getClassID

public int getClassID()

DOCUMENT ME!

Specified by:

getClassID in interface Object

Returns:

the classID

See Also:

#classID

getObjectID

public int getObjectID()

DOCUMENT ME!

Returns:

the objectID

getUser

public User getUser()

DOCUMENT ME!

Returns:

the user

compareTo

public int compareTo(LightweightMetaObject o)

DOCUMENT ME!

Specified by:

compareTo in interface Comparable<LightweightMetaObject>

Parameters:

o - DOCUMENT ME!

Returns:

DOCUMENT ME!

getMetaService

public MetaService getMetaService()

DOCUMENT ME!

Returns:

the metaService

setMetaService

public void setMetaService(MetaService metaService)

DOCUMENT ME!

Parameters:

metaService - the metaService to set

getRealMetaObject

public MetaObject getRealMetaObject()

Lazy loads for the real MetaObject if needed, the returns it.

Returns:

the real MetaObject which the LWMetaObject is a proxy for.

setID

public void setID(int objectID)

DOCUMENT ME!

Specified by:

setID in interface Object

Parameters:

objectID - DOCUMENT ME!

getID

public int getID()

DOCUMENT ME!

Specified by:

getID in interface Object

Returns:

DOCUMENT ME!

See Also:

#objectID

getId

public int getId()

Description copied from interface: Groupable

DOCUMENT ME!

Specified by:

getId in interface MetaObject

Specified by:

getId in interface Groupable

Returns:

DOCUMENT ME!

getDomain

public String getDomain()

Description copied from interface: MetaObject

getter for domain.

Specified by:

getDomain in interface MetaObject

Returns:

domain

getClassKey

public String getClassKey()

Description copied from interface: MetaObject

getter for classKey.

Specified by:

getClassKey in interface MetaObject

Returns:

classKey

alreadyFetched

public boolean alreadyFetched()

DOCUMENT ME!

Returns:

DOCUMENT ME!

hasObjectReadPermission

public boolean hasObjectReadPermission(User user)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

hasObjectReadPermission in interface MetaObject

Parameters:

user - DOCUMENT ME!

Returns:

DOCUMENT ME!

hasObjectWritePermission

public boolean hasObjectWritePermission(User user)

Description copied from interface: MetaObject

DOCUMENT ME!

Specified by:

hasObjectWritePermission in interface MetaObject

Parameters:

user - DOCUMENT ME!

Returns:

true, iff the given user has write permission on the object

clearCache

public static void clearCache()

DOCUMENT ME!

invalidateCacheFor

public static boolean invalidateCacheFor(String domain,
                                         int classId,
                                         int objectId)

DOCUMENT ME!

Parameters:

domain - mo DOCUMENT ME!

classId - DOCUMENT ME!

objectId - DOCUMENT ME!

Returns:

DOCUMENT ME!

getConnectionContext

public de.cismet.connectioncontext.ConnectionContext getConnectionContext()

Specified by:

getConnectionContext in interface de.cismet.connectioncontext.ConnectionContextProvider

Specified by:

getConnectionContext in interface de.cismet.connectioncontext.ConnectionContextStore

initWithConnectionContext

public void initWithConnectionContext(de.cismet.connectioncontext.ConnectionContext connectionContext)

Specified by:

initWithConnectionContext in interface de.cismet.connectioncontext.ConnectionContextStore