org.torweg.pulse.accesscontrol.attributes
Class StringAttribute

java.lang.Object
  org.torweg.pulse.util.entity.AbstractBasicEntity
      org.torweg.pulse.util.entity.Node
          org.torweg.pulse.accesscontrol.attributes.AbstractAttribute<java.lang.String>
              org.torweg.pulse.accesscontrol.attributes.StringAttribute

All Implemented Interfaces:

java.io.Serializable, JDOMable, INameable, INamed

@Entity
public class StringAttribute
extends AbstractAttribute<java.lang.String>
implements INameable

a very simple Attribute storing a String.

Version:

$Revision: 1809 $

Author:

Thomas Weber, Daniel Dietz

See Also:

Serialized Form

Field Summary

Fields inherited from class org.torweg.pulse.accesscontrol.attributes.AbstractAttribute

LOGGER

Constructor Summary

StringAttribute()
creates a new StringAttribute, which is not a system attribute.

StringAttribute(boolean isSystem)
creates a new StringAttribute.

StringAttribute(java.lang.String n)
creates a new StringAttribute with the given name.

StringAttribute(java.lang.String n, boolean isSystem)
creates a new StringAttribute with the given name.

Method Summary

org.jdom.Element	deserializeToJDOM() returns a JDOM representation of the attribute.
org.jdom.Element	deserializeToJDOM(java.util.Map<java.lang.Long,AbstractValue<?>> valueMap) returns a JDOM representation of the attribute.
AbstractAttribute<java.lang.String>	getAttributeInstance(java.lang.String n, boolean isSystem) returns a new instance of this attribute-class.
AbstractTypedCheck<java.lang.String>	getCheck() returns the check.
java.lang.String	getName() returns the attributes name.
protected java.lang.String	getParameterName() returns the parameter name.
void	setCheck(AbstractTypedCheck<java.lang.String> c) sets the check.
void	setName(java.lang.String n) sets the name of the attribute.
net.sf.json.JSONObject	toJSON() returns a JSONObject representation of the Node .
AbstractAttribute<java.lang.String>	updateSettingsFromCommand(Command command, org.hibernate.Session session) does nothing since BooleanAttributes do not have any settings.
AbstractValue<java.lang.String>	valueFromCommand(Command c) initializes a value of this attribute from the given command.

Methods inherited from class org.torweg.pulse.accesscontrol.attributes.AbstractAttribute

addAdminEditRole, addAdminViewRole, addSelfEditRole, addSelfViewRole, addTriggeredRole, getAdminEditRoles, getAdminViewRoles, getSelfEditRoles, getSelfViewRoles, getTriggeredRoles, getTypedChecks, getValue, isRequired, isSystemAttribute, isValid, removeAdminEditRole, removeAdminViewRole, removeSelfEditRole, removeSelfViewRole, removeTriggeredRole, setAdminEditRoles, setAdminViewRoles, setRequired, setSelfEditRoles, setSelfViewRoles, setTriggeredRoles, setValue

Methods inherited from class org.torweg.pulse.util.entity.Node

addChild, addChild, getChild, getChildIndex, getChildren, getParent, hasChildren, removeChild, setChildren

Methods inherited from class org.torweg.pulse.util.entity.AbstractBasicEntity

compareTo, equals, getFullQualifiedClassNameJAXB, getId, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

StringAttribute

public StringAttribute()

creates a new StringAttribute, which is not a system attribute.

StringAttribute

public StringAttribute(boolean isSystem)

creates a new StringAttribute.

Parameters:

isSystem - flag, indicating whether the attribute is a system attribute

StringAttribute

public StringAttribute(java.lang.String n)

creates a new StringAttribute with the given name.

Parameters:

n - the name

StringAttribute

public StringAttribute(java.lang.String n,
                       boolean isSystem)

creates a new StringAttribute with the given name.

Parameters:

n - the name

isSystem - flag, indicating whether the attribute is a system attribute

Method Detail

setName

public final void setName(java.lang.String n)

sets the name of the attribute.

Specified by:

setName in interface INameable

Parameters:

n - the name to set

See Also:

INameable.setName(String)

getName

public final java.lang.String getName()

returns the attributes name.

Specified by:

getName in interface INamed

Specified by:

getName in class AbstractAttribute<java.lang.String>

Returns:

the name

getCheck

public final AbstractTypedCheck<java.lang.String> getCheck()

returns the check.

Specified by:

getCheck in class AbstractAttribute<java.lang.String>

Returns:

the check

See Also:

AbstractAttribute.getCheck()

setCheck

public final void setCheck(AbstractTypedCheck<java.lang.String> c)

sets the check.

Specified by:

setCheck in class AbstractAttribute<java.lang.String>

Parameters:

c - the check to set

See Also:

AbstractAttribute.setCheck(org.torweg.pulse.accesscontrol.attributes.AbstractTypedCheck)

deserializeToJDOM

public final org.jdom.Element deserializeToJDOM()

returns a JDOM representation of the attribute.

Specified by:

deserializeToJDOM in interface JDOMable

Overrides:

deserializeToJDOM in class AbstractAttribute<java.lang.String>

Returns:

a JDOM representation of the attribute

See Also:

AbstractAttribute.deserializeToJDOM()

deserializeToJDOM

public final org.jdom.Element deserializeToJDOM(java.util.Map<java.lang.Long,AbstractValue<?>> valueMap)

returns a JDOM representation of the attribute.

used during deserialization of a User

Overrides:

deserializeToJDOM in class AbstractAttribute<java.lang.String>

Parameters:

valueMap - maps attribute-ids a Users attribute-values

Returns:

a JDOM representation of the attribute

See Also:

AbstractAttribute.deserializeToJDOM()

toJSON

public final net.sf.json.JSONObject toJSON()

returns a JSONObject representation of the Node .

Overrides:

toJSON in class AbstractAttribute<java.lang.String>

Returns:

a JSONObject representation of the Node

getAttributeInstance

public final AbstractAttribute<java.lang.String> getAttributeInstance(java.lang.String n,
                                                                      boolean isSystem)

returns a new instance of this attribute-class.

Specified by:

getAttributeInstance in class AbstractAttribute<java.lang.String>

Parameters:

n - the name of the new attribute

isSystem - indicates if new attribute is system-attribute

Returns:

a new instance of this attribute-class

valueFromCommand

public final AbstractValue<java.lang.String> valueFromCommand(Command c)

initializes a value of this attribute from the given command.

Specified by:

valueFromCommand in class AbstractAttribute<java.lang.String>

Parameters:

c - the command

Returns:

a value of this attribute initialized from the given command

updateSettingsFromCommand

public final AbstractAttribute<java.lang.String> updateSettingsFromCommand(Command command,
                                                                           org.hibernate.Session session)

does nothing since BooleanAttributes do not have any settings.

Specified by:

updateSettingsFromCommand in class AbstractAttribute<java.lang.String>

Parameters:

command - is ignored

session - is not used

Returns:

the current instance

See Also:

AbstractAttribute.updateSettingsFromCommand(Command, Session)

getParameterName

protected final java.lang.String getParameterName()

returns the parameter name.

Returns:

the parameter name