Class (cids Server [9.3-SNAPSHOT] 9.3-SNAPSHOT API)

java.lang.Object
- Sirius.server.localserver._class.Class

All Implemented Interfaces:

Serializable, Mapable

Direct Known Subclasses:

MetaClass
```
public class Class
extends Object
implements Serializable, Mapable
```
Die Klasse Class fungiert zum einen als Mittel zur Klassifkation zum anderen enthält Sie Eigenschaften von referenzierten Tabellen.

Version:

$Revision$, $Date$

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`arrayElementLink` indicates whether objects of this class are only links between an array and it's elements.
`protected AttributeVector`	`attribs` Alle Attribute der Klasse.
`protected Policy`	`attributePolicy`
`protected String`	`description` Enthält eine URL oder einen Klartext der die Klasse näher beschreibt.
`protected String`	`editor` definiert die java Klasse welche als Editor für diese Art von Objekten benutzt werden soll.
`protected String`	`getDefaultInstanceStmnt` statement welches ein template eines meta objektes dieser Klasser erzeugt.
`protected String`	`getEmptyResultStmnt`
`protected String`	`getInstanceStmnt` sql statement welches eine instanz eines meta objektes dieser Klasse erzeugt.
`protected Image`	`icon` Icon wird bei der Visualisierung der Klasse angzeigt.
`protected int`	`id` Fungiert als Klassenreferenz in einem assoziativen Container.
`protected boolean`	`indexed`
`protected LinkedHashMap`	`memberAttributeInfos` enthält information über die Attribute der Objekte der Klasse, diesen werden zur Konstruktion von Objekten benötigt.
`protected String`	`name` Name der Klasse wird bei der Visualisierung angzeigt.
`protected Image`	`objectIcon` Icon wird bei der Visualisierung eines Objekts der Klasse angzeigt.
`protected PermissionHolder`	`permissions` Zugriffsrechte bzgl.
`protected String`	`primaryKey` Primaeschluessel der zur Klasse gehörenden Tabelle.
`protected String`	`renderer` DOCUMENT ME!
`protected String`	`tableName` zur Klasse gehörender Tabellenname.
`protected String`	`toString` voll qualifizierter Klassename zur erzeugung einer Stringrepräsentation von Objekten dieser Klasse.

Constructor Summary

Constructors
Constructor and Description
`Class(int id, String name, String description, Image icon, Image objectIcon, String tableName, String primaryKey, String toString, PermissionHolder permissions, Policy attributePolicy, boolean indexed)` Erzeug eine unattributierte Klasse.
`Class(int id, String name, String description, Image icon, Image objectIcon, String tableName, String primaryKey, String toString, Policy policy, Policy attributePolicy, boolean indexed)` Erzeug eine unattributierte Klasse.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addAttribute(Object anyAttribute)` Fügt ein Klassenattribut in die davor vorgesehenen AtrributVectoren ein.
`void`	`addMemberAttributeInfo(MemberAttributeInfo mai)` adds an AttributeinfoItem to the class.
`Object`	`constructKey(Mapable m)` Deprecated. UNUSED
`ClassAttribute[]`	`getAttribs()` retrives class attributes.
`Collection`	`getAttributeByName(String name)` retrieves an attribute referenced by its name.
`Policy`	`getAttributePolicy()` DOCUMENT ME!
`Collection`	`getAttributes()` retrieves class attributes.
`ClassAttribute`	`getClassAttribute(String key)` DOCUMENT ME!
`String`	`getDescription()` getter for description.
`String`	`getEditor()` Getter for property editor.
`Collection`	`getFieldNames()` retrieves the names of all attributes of this class'es objects.
`String`	`getGetDefaultInstanceStmnt()` getter for defaultInstanceStatement.
`String`	`getGetEmptyResultStmnt()` DOCUMENT ME!
`String`	`getGetInstanceStmnt()` Getter for property getInstanceStmnt.
`Image`	`getIcon()` getter für Icon.
`int`	`getID()` getter für ID.
`Object`	`getKey()` retrieves the key (Mapable) for this class.
`HashMap`	`getMemberAttributeInfos()` Getter for property memberAttributeInfos.
`String`	`getName()` getter für name.
`Image`	`getObjectIcon()` get für ObjectIcon.
`PermissionHolder`	`getPermissions()` getter for permissions.
`Policy`	`getPolicy()` DOCUMENT ME!
`String`	`getPrimaryKey()` Getter for property primaryKey.
`String`	`getRenderer()` Getter for property renderer.
`String`	`getSQLFieldNames()` retrieves the names of the sql fields of the corresponding table.
`String`	`getTableName()` Getter for property tableName.
`String`	`getToString()` Getter for property toString.
`boolean`	`isArrayElementLink()` whether objects of the class are mere association between array objects and their elements.
`boolean`	`isIndexed()` DOCUMENT ME!
`void`	`setArrayElementLink(boolean arrayElementLink)` setter for arrayElementLink.
`void`	`setEditor(String editor)` Setter for property editor.
`void`	`setIndexed(boolean indexed)` DOCUMENT ME!
`void`	`setMemberAttributeInfos(LinkedHashMap memberAttributeInfos)` Setter for property memberAttributeInfos.
`void`	`setPrimaryKey(String primaryKey)` Setter for property primaryKey.
`void`	`setRenderer(String renderer)` Setter for property renderer.
`void`	`setTableName(String tableName)` Setter for property tableName.
`void`	`setToString(String toString)` Setter for property toString.
`String`	`toString()` uses the toStringConverter if applicable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected final int id
```
    Fungiert als Klassenreferenz in einem assoziativen Container.
    
    See Also:
    
    Sirius.Class.ClassMap
  - name
```
protected String name
```
    Name der Klasse wird bei der Visualisierung angzeigt.
  - description
```
protected String description
```
    Enthält eine URL oder einen Klartext der die Klasse näher beschreibt.
  - icon
```
protected Image icon
```
    Icon wird bei der Visualisierung der Klasse angzeigt.
  - objectIcon
```
protected Image objectIcon
```
    Icon wird bei der Visualisierung eines Objekts der Klasse angzeigt.
  - permissions
```
protected PermissionHolder permissions
```
    Zugriffsrechte bzgl. Benutzergruppen
  - tableName
```
protected String tableName
```
    zur Klasse gehörender Tabellenname.
  - primaryKey
```
protected String primaryKey
```
    Primaeschluessel der zur Klasse gehörenden Tabelle.
  - toString
```
protected String toString
```
    voll qualifizierter Klassename zur erzeugung einer Stringrepräsentation von Objekten dieser Klasse.
  - arrayElementLink
```
protected boolean arrayElementLink
```
    indicates whether objects of this class are only links between an array and it's elements.
  - attribs
```
protected AttributeVector attribs
```
    Alle Attribute der Klasse.
  - memberAttributeInfos
```
protected LinkedHashMap memberAttributeInfos
```
    enthält information über die Attribute der Objekte der Klasse, diesen werden zur Konstruktion von Objekten benötigt.
  - getInstanceStmnt
```
protected String getInstanceStmnt
```
    sql statement welches eine instanz eines meta objektes dieser Klasse erzeugt.
  - getDefaultInstanceStmnt
```
protected String getDefaultInstanceStmnt
```
    statement welches ein template eines meta objektes dieser Klasser erzeugt.
  - getEmptyResultStmnt
```
protected String getEmptyResultStmnt
```
  - editor
```
protected String editor
```
    definiert die java Klasse welche als Editor für diese Art von Objekten benutzt werden soll.
  - renderer
```
protected String renderer
```
    DOCUMENT ME!
  - attributePolicy
```
protected Policy attributePolicy
```
  - indexed
```
protected boolean indexed
```
- Constructor Detail
  - Class
```
public Class(int id,
             String name,
             String description,
             Image icon,
             Image objectIcon,
             String tableName,
             String primaryKey,
             String toString,
             PermissionHolder permissions,
             Policy attributePolicy,
             boolean indexed)
```
    Erzeug eine unattributierte Klasse.
    
    Parameters:
    
    id - this class key unique on on domain
    
    name - name of this class
    
    description - -
    
    icon - nodes representing this class will be vizualized using this icon
    
    objectIcon - objects of this class will be vizualized using this icon
    
    tableName - name of this class' corresponding table
    
    primaryKey - primary key of the table
    
    toString - class able to create a String representation of this class's objects
    
    permissions - permission container
    
    attributePolicy - DOCUMENT ME!
    
    indexed - DOCUMENT ME!
  - Class
```
public Class(int id,
             String name,
             String description,
             Image icon,
             Image objectIcon,
             String tableName,
             String primaryKey,
             String toString,
             Policy policy,
             Policy attributePolicy,
             boolean indexed)
```
    Erzeug eine unattributierte Klasse.
    
    Parameters:
    
    id - key
    
    name - name der Klasse
    
    description - Beschreibung der Klasse
    
    icon - nodes representing this class will be vizualized using this icon
    
    objectIcon - objects of this class will be vizualized using this icon
    
    tableName - name of this class' corresponding table
    
    primaryKey - primary key of the table
    
    toString - class able to create a String representation of this class's objects
    
    policy - DOCUMENT ME!
    
    attributePolicy - DOCUMENT ME!
    
    indexed - DOCUMENT ME!
- Method Detail
  - getObjectIcon
```
public final Image getObjectIcon()
```
    get für ObjectIcon.
    
    Returns:
    
    Image
    
    See Also:
    
    objectIcon
  - getIcon
```
public final Image getIcon()
```
    getter für Icon.
    
    Returns:
    
    Image
    
    See Also:
    
    icon
  - getID
```
public final int getID()
```
    getter für ID.
    
    Returns:
    
    id of this class
    
    See Also:
    
    #classID
  - getName
```
public final String getName()
```
    getter für name.
    
    Returns:
    
    name of this class
    
    See Also:
    
    name
  - getDescription
```
public final String getDescription()
```
    getter for description.
    
    Returns:
    
    description of this class
    
    See Also:
    
    description
  - addAttribute
```
protected final void addAttribute(Object anyAttribute)
                           throws Exception
```
    Fügt ein Klassenattribut in die davor vorgesehenen AtrributVectoren ein.
    
    Parameters:
    
    anyAttribute - Klassenattribut
    
    Throws:
    
    Exception - DOCUMENT ME!
  - getAttribs
```
public final ClassAttribute[] getAttribs()
```
    retrives class attributes.
    
    Returns:
    
    list of class attributes
  - getClassAttribute
```
public final ClassAttribute getClassAttribute(String key)
```
    DOCUMENT ME!
    
    Parameters:
    
    key - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getAttributes
```
public final Collection getAttributes()
```
    retrieves class attributes.
    
    Returns:
    
    collection of class attributes
  - getAttributeByName
```
public Collection getAttributeByName(String name)
```
    retrieves an attribute referenced by its name.
    
    Parameters:
    
    name - name of an attribute
    
    Returns:
    
    attribute with this name or null if no attribute with this name exists
  - getPermissions
```
public final PermissionHolder getPermissions()
```
    getter for permissions.
    
    Returns:
    
    permissionHolder contains all permission entries for this class
  - getToString
```
public String getToString()
```
    Getter for property toString.
    
    Returns:
    
    Value of property toString.
  - setToString
```
public void setToString(String toString)
```
    Setter for property toString.
    
    Parameters:
    
    toString - New value of property toString.
  - getTableName
```
public String getTableName()
```
    Getter for property tableName.
    
    Returns:
    
    Value of property tableName.
  - setTableName
```
public void setTableName(String tableName)
```
    Setter for property tableName.
    
    Parameters:
    
    tableName - New value of property tableName.
  - getPrimaryKey
```
public String getPrimaryKey()
```
    Getter for property primaryKey.
    
    Returns:
    
    Value of property primaryKey.
  - setPrimaryKey
```
public void setPrimaryKey(String primaryKey)
```
    Setter for property primaryKey.
    
    Parameters:
    
    primaryKey - New value of property primaryKey.
  - getKey
```
public Object getKey()
```
    retrieves the key (Mapable) for this class.
    
    Specified by:
    
    getKey in interface Mapable
    
    Returns:
    
    key to register in a Map
  - getMemberAttributeInfos
```
public HashMap getMemberAttributeInfos()
```
    Getter for property memberAttributeInfos.
    
    Returns:
    
    Value of property memberAttributeInfos.
  - setMemberAttributeInfos
```
public void setMemberAttributeInfos(LinkedHashMap memberAttributeInfos)
```
    Setter for property memberAttributeInfos.
    
    Parameters:
    
    memberAttributeInfos - New value of property memberAttributeInfos.
  - addMemberAttributeInfo
```
public void addMemberAttributeInfo(MemberAttributeInfo mai)
```
    adds an AttributeinfoItem to the class. Used during construction of objects of this class
    
    Parameters:
    
    mai - Info set about an Attribute of this class's objects
  - constructKey
```
public Object constructKey(Mapable m)
```
    Deprecated. UNUSED
    
    no longer used.
    
    Specified by:
    
    constructKey in interface Mapable
    
    Parameters:
    
    m - object
    
    Returns:
    
    key
  - getFieldNames
```
public Collection getFieldNames()
```
    retrieves the names of all attributes of this class'es objects.
    
    Returns:
    
    attribute names
  - getGetInstanceStmnt
```
public String getGetInstanceStmnt()
```
    Getter for property getInstanceStmnt.
    
    Returns:
    
    Value of property getInstanceStmnt.
  - getGetDefaultInstanceStmnt
```
public String getGetDefaultInstanceStmnt()
```
    getter for defaultInstanceStatement.
    
    Returns:
    
    sql statement capable of creating a default instance
  - getGetEmptyResultStmnt
```
public String getGetEmptyResultStmnt()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - toString
```
public String toString()
```
    uses the toStringConverter if applicable.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this class
  - getEditor
```
public String getEditor()
```
    Getter for property editor.
    
    Returns:
    
    Value of property editor.
  - setEditor
```
public void setEditor(String editor)
```
    Setter for property editor.
    
    Parameters:
    
    editor - New value of property editor.
  - getRenderer
```
public String getRenderer()
```
    Getter for property renderer.
    
    Returns:
    
    Value of property renderer.
  - setRenderer
```
public void setRenderer(String renderer)
```
    Setter for property renderer.
    
    Parameters:
    
    renderer - New value of property renderer.
  - getSQLFieldNames
```
public String getSQLFieldNames()
```
    retrieves the names of the sql fields of the corresponding table.
    
    Returns:
    
    list of field name
  - setArrayElementLink
```
public void setArrayElementLink(boolean arrayElementLink)
```
    setter for arrayElementLink.
    
    Parameters:
    
    arrayElementLink - is arrayElemtneLink
  - isArrayElementLink
```
public boolean isArrayElementLink()
```
    whether objects of the class are mere association between array objects and their elements.
    
    Returns:
    
    is association between arrays and their elements
  - getPolicy
```
public Policy getPolicy()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getAttributePolicy
```
public Policy getAttributePolicy()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - isIndexed
```
public boolean isIndexed()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - setIndexed
```
public void setIndexed(boolean indexed)
```
    DOCUMENT ME!
    
    Parameters:
    
    indexed - DOCUMENT ME!

Class Class

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

description

icon

objectIcon

permissions

tableName

primaryKey

toString

arrayElementLink

attribs

memberAttributeInfos

getInstanceStmnt

getDefaultInstanceStmnt

getEmptyResultStmnt

editor

renderer

attributePolicy

indexed

Constructor Detail

Class

Class

Method Detail

getObjectIcon

getIcon

getID

getName

getDescription

addAttribute

getAttribs

getClassAttribute

getAttributes

getAttributeByName

getPermissions

getToString

setToString

getTableName

setTableName

getPrimaryKey

setPrimaryKey

getKey

getMemberAttributeInfos

setMemberAttributeInfos

addMemberAttributeInfo

constructKey

getFieldNames

getGetInstanceStmnt

getGetDefaultInstanceStmnt

getGetEmptyResultStmnt

toString

getEditor

setEditor

getRenderer

setRenderer

getSQLFieldNames

setArrayElementLink

isArrayElementLink

getPolicy

getAttributePolicy

isIndexed

setIndexed