com.highqsoft.odsx.dialog

Class OdsxAttributeEditorPaneValue

java.lang.Object

java.util.AbstractMap

com.highqsoft.fwk.dialog.FwkDialogPaneValue

com.highqsoft.odsx.dialog.OdsxAttributeEditorPaneValue

All Implemented Interfaces:

FwkDialogPaneValueInterface, FwkInterface, FwkPropertyChangeInterface, java.io.Serializable, java.lang.Cloneable, java.util.Map

public class OdsxAttributeEditorPaneValue
extends FwkDialogPaneValue
implements java.lang.Cloneable

The OdsxAttributeEditorPaneValue.

Since:

$Date: 2017/04/06 13:29:52 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.HashMap	not_editable
protected static java.lang.Object	NOT_EDITABLE
protected static java.lang.Object	OBLIGATORY
protected static java.lang.Object	UNIQUE

Fields inherited from class com.highqsoft.fwk.dialog.FwkDialogPaneValue

getHt, ident, propertyChange, setHt, version

Constructor Summary

Constructors

Constructor and Description
OdsxAttributeEditorPaneValue() The construtor.
OdsxAttributeEditorPaneValue(ApplicationElement ae) The construtor.
OdsxAttributeEditorPaneValue(InstanceElement ie) The construtor.
OdsxAttributeEditorPaneValue(java.lang.String ident) The constructor.
OdsxAttributeEditorPaneValue(java.lang.String ident, ApplicationElement ae) The constructor.
OdsxAttributeEditorPaneValue(java.lang.String ident, InstanceElement ie) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ApplicationAttribute aa) Add an application attribute to the value.
void	add(NameValueUnit nvu) Add a name value unit to the value.
void	clear() Clear the whole collection of name value units.
java.lang.Object	clone() Clone the value.
void	fillFrom(ApplicationElement ae) Fill from ApplicationElement.
void	fillFrom(InstanceElement ie) Fill from InstanceElement.
NameValueUnit	get(java.lang.String name) Get a name value unit from the value.
java.util.Iterator	getProperties() Retrieves a map that holds all property keywords of the pane value.
java.lang.Object	getProperty(java.lang.String propertyName) Retrieves the property that belongs to the specified property name.
java.lang.String	getUnit(java.lang.String name) Get a unit.
java.lang.String	getValueAsString(java.lang.String name) Get a name value as string.
static boolean	isEditable(ApplicationAttribute aa) Get the editable flag.
static boolean	isEditable(java.lang.String name) Get the editable flag.
boolean	isObligatory(java.lang.String name) Get the attribute obligatory flag.
boolean	isUnique(java.lang.String name) Get the attribute unique flag.
static void	main(java.lang.String[] args) The Main Body to test the class.
NameValueUnit	remove(NameValueUnit nvu) Remove a name value unit from the value.
NameValueUnit	remove(java.lang.String name) Remove a named name value unit from the value.
void	setObligatory(java.lang.String name, boolean flag) Set the attribute obligatory.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Sets the property that belongs to the specified identifier.
void	setUnique(java.lang.String name, boolean flag) Set the attribute unique.
int	size() Retrieve the size of the attribute array.
java.lang.String	toString() Get a string presentation of the value.

Methods inherited from class com.highqsoft.fwk.dialog.FwkDialogPaneValue

addPropertyChangeListener, addPropertyChangeListener, entrySet, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getIdent, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, getVersion, isPropertyChangeEventSuspended, release, removePropertyChangeListener, removePropertyChangeListener, setIdent, setProperties, setSource, suspendPropertyChangeEvents

Methods inherited from class java.util.AbstractMap

containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, values

Field Detail

OBLIGATORY

protected static final java.lang.Object OBLIGATORY

UNIQUE

protected static final java.lang.Object UNIQUE

NOT_EDITABLE

protected static final java.lang.Object NOT_EDITABLE

not_editable

protected static java.util.HashMap not_editable

Constructor Detail

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue()

The construtor.

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue(java.lang.String ident)

The constructor.

Parameters:

ident - The ident of the value.

ie - The instance element belongs to the value.

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue(ApplicationElement ae)
                             throws AoException

The construtor.

Parameters:

ae - an application element

Throws:

AoException

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue(java.lang.String ident,
                            ApplicationElement ae)
                             throws AoException

The constructor.

Parameters:

ident - The ident of the value.

ae - The application element that fills the value.

Throws:

AoException

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue(InstanceElement ie)
                             throws AoException

The construtor.

Parameters:

ie - an instance element

Throws:

AoException

OdsxAttributeEditorPaneValue

public OdsxAttributeEditorPaneValue(java.lang.String ident,
                            InstanceElement ie)
                             throws AoException

The constructor.

Parameters:

ident - The ident of the value.

ie - The instance element that fills the value.

Throws:

AoException

Method Detail

size

public int size()

Retrieve the size of the attribute array.

Specified by:

size in interface java.util.Map

Overrides:

size in class java.util.AbstractMap

Returns:

to total number of available attributes.

setObligatory

public void setObligatory(java.lang.String name,
                 boolean flag)

Set the attribute obligatory.

Parameters:

name - the name of the value that should be obligatory.

flag - true if value should be obligatory.

isObligatory

public boolean isObligatory(java.lang.String name)

Get the attribute obligatory flag.

Parameters:

name - the name of the value that should be obligatory.

Returns:

true if value should be obligatory.

setUnique

public void setUnique(java.lang.String name,
             boolean flag)

Set the attribute unique.

Parameters:

name - the name of the value that should be unique.

flag - true if value should be unique.

isUnique

public boolean isUnique(java.lang.String name)

Get the attribute unique flag.

Parameters:

name - the name of the value that should be unique.

Returns:

true if value should be unique.

isEditable

public static boolean isEditable(java.lang.String name)

Get the editable flag.

Parameters:

name - the base element name.

Returns:

true if value is editable.

isEditable

public static boolean isEditable(ApplicationAttribute aa)

Get the editable flag.

Parameters:

aa - the application attribute.

Returns:

true if value is editable.

add

public void add(NameValueUnit nvu)

Add a name value unit to the value.

This method doesn't make a copy of the name value unit.

Parameters:

nvu - The name value unit.

add

public void add(ApplicationAttribute aa)
         throws AoException

Add an application attribute to the value.

Parameters:

aa - the application attribute.

Throws:

AoException

fillFrom

public void fillFrom(ApplicationElement ae)
              throws AoException

Fill from ApplicationElement. The collection will be cleared before.

Parameters:

ae - the application element.

Throws:

AoException

fillFrom

public void fillFrom(InstanceElement ie)
              throws AoException

Fill from InstanceElement. The collection will be cleared before.

Parameters:

ie - the instance element.

Throws:

AoException

get

public NameValueUnit get(java.lang.String name)

Get a name value unit from the value.

This method doesn't make a copy of the name value unit.

Parameters:

name - The name of the name value unit.

Returns:

The name value unit or null if not found.

getValueAsString

public java.lang.String getValueAsString(java.lang.String name)

Get a name value as string.

Parameters:

name - The name of the name value unit.

Returns:

The string value of name value unit or null if not found.

getUnit

public java.lang.String getUnit(java.lang.String name)

Get a unit.

Parameters:

name - The name of the name value unit.

Returns:

The unit string of name value unit or null if not found.

remove

public NameValueUnit remove(NameValueUnit nvu)

Remove a name value unit from the value.

Parameters:

nvu - The name value unit

Returns:

the removed name value unit or null

remove

public NameValueUnit remove(java.lang.String name)

Remove a named name value unit from the value.

Parameters:

name - The name of the property

Returns:

the removed name value unit or null

clear

public void clear()

Clear the whole collection of name value units.

Specified by:

clear in interface java.util.Map

Overrides:

clear in class java.util.AbstractMap

clone

public java.lang.Object clone()

Clone the value.

Overrides:

clone in class java.util.AbstractMap

setProperty

public void setProperty(java.lang.String propertyName,
               java.lang.Object propertyValue)

Sets the property that belongs to the specified identifier.

Specified by:

setProperty in interface FwkDialogPaneValueInterface

Overrides:

setProperty in class FwkDialogPaneValue

Parameters:

propertyName - The name name of the property.

propertyValue - The new value of the property.

getProperties

public java.util.Iterator getProperties()

Retrieves a map that holds all property keywords of the pane value. The keys of the map are the identifiers of the properties.

Specified by:

getProperties in interface FwkDialogPaneValueInterface

Overrides:

getProperties in class FwkDialogPaneValue

Returns:

The name-value map.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Retrieves the property that belongs to the specified property name.

Specified by:

getProperty in interface FwkDialogPaneValueInterface

Overrides:

getProperty in class FwkDialogPaneValue

Parameters:

propertyName - The name name of the property.

Returns:

propertyValue The value of the property. This value is an instance of NameValueUnit.

toString

public java.lang.String toString()

Get a string presentation of the value.

Overrides:

toString in class FwkDialogPaneValue

Returns:

the string presentation.

main

public static void main(java.lang.String[] args)

The Main Body to test the class.