no.g9.client.support

Class AbstractNode<T>

java.lang.Object

no.g9.client.support.AbstractNode<T>

Type Parameters:

T - The domain class type represented by this node

All Implemented Interfaces:

ObjectSelectionNode, Visitable<ObjectSelectionNode>

public abstract class AbstractNode<T>
extends Object
implements ObjectSelectionNode

The class representing a target in the object selection. Implements common methods for the object selection nodes.

Field Summary

Fields

Modifier and Type	Field and Description
protected DomainObjectProxy	objectProxy The object proxy representing the domain object

Fields inherited from interface no.g9.client.support.ObjectSelectionNode

CLEAN, CLEARED, DIRTY, EDITED

Constructor Summary

Constructors

Constructor and Description
AbstractNode()

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor<ObjectSelectionNode> visitor)
protected void	addToAssociation(String roleName, Object domainObject, Set association) Internal use
abstract void	append(T domainInstance, String field) Appends the value from the specified field (if possible) to the corresponding text area.
protected void	appendOnEDT(T domainInstance, String field) INTERNAL USE.
boolean	checkChanged() If the dialog controllers ignoreCheckChange is false this method checks if the node (with children) is unchanged.
boolean	checkChangedAsChild() Recursivly calls check change and then checks the integrity of the relation of this target and the parent target if the target is up-related.
boolean	checkClear() If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action clear.
boolean	checkClose() If the dialog controllers Determin if it is ok to proceed with action close window.
boolean	checkDelete() If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action delete.
boolean	checkFind() If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with find action.
boolean	checkPrint()
boolean	checkRowSelection(int oldSelection, int newSelection) If the controller's ignoreCheckChange property is false, determine if it is ok to proceed to change the selected row in a listblock.
boolean	checkRowSelection(int oldSelection, int newSelection, Set foreignNodes)
boolean	checkSave() If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action save.
protected void	clearAllAssociation() Clears all associations for the role.
protected void	clearKeepKeysOnEDT() INTERNAL USE.
protected void	clearOnEDT() INTERNAL USE.
protected void	clearOnEDT(String s) INTERNAL USE.
abstract void	display(String attributeName, Object value) Displays the specified attribute value.
abstract void	display(String attributeName, Object value, boolean resetState) Updates data of given attriubte in object selection in the dialog.
abstract void	display(T domainInstance, String attributeName, boolean resetState) Updates data of given attriubte in object selection in the dialog.
abstract void	displayAboveTarget(Collection resultObject, List pathToTarget, boolean findAll) Displays the collection of domain objects.
void	displayOnEDT(Collection resultObject, List pathToTarget, boolean findAll) Performs a recursive display.
protected void	displayOnEDT(Object domainInstance) INTERNAL USE.
protected void	displayOnEDT(String attributeName, Object value, boolean resetState) INTERNAL USE.
protected void	displayOnEDT(T domainInstance, String attributeName, boolean resetState) INTERNAL USE.
Set	getAllChildNames() Returns a Set of Strings containing the names of all children (recursively).
protected Object	getAssociation(String roleName, Object domainObject) Internal use.
Set	getChangedNoKeyFields() Returns a set containing all fields that have changed since the initial display and wich are not part of the key, in other words the complement of the set derived by getChangedKeyFields
abstract Object	getEmptyDomainObject() Returns an empty instance of the domain object represented by this object selection target.
List<AbstractNode>	getPathToNode() Returns the path from the root node to this node.
DomainObjectProxy	getProxy() Retuns the domain object proxy for this target.
Map	getRoleNameToAssociationMap() Experimental.
ObjectSelectionNode	getRootNode() Returns the root node of this object selection node.
int	getState() Returns the current state of this node.
Object	greedyObtain() Internal use.
boolean	inListblock() Returns true if this role is a listblock role.
boolean	isChanged(String attributeName) Check if the specified attribute is changed.
abstract boolean	isNavigableToParent() Internal use.
boolean	isRootNode() Check if this is a root node and if so, return true
abstract void	mergeAssociations(Object domainObject, List pathToTarget, boolean error) Internal use.
void	nullProxy() Recursivly releases the proxy on this target.
Set	obtainSet() Deprecated. use obtainSet(boolean)
Set	obtainSet(boolean createIfNull) Obtains a set of domain objects.
Object	peekAtObject() Returns a shallow copy of the domain object, where attributes are read from the dialog.
void	recursiveDisplay(Collection domainObjectCollection) Displays the Set of domain objects.
void	removeFromParent(Object root) Internal use.
void	resetAssociations(Object o) Internal use.
protected void	saveAssociation(String roleName, Object domainObject, Object association) Internal use.
protected abstract void	setAssociation(Object self, String associationRoleName, Object association) Internal use.
protected void	setEnabledOnEDT(boolean enable) INTERNAL USE.
protected void	setEnabledOnEDT(boolean enable, String field) INTERNAL USE.
protected void	setFocusOnEDT(String field) INTERNAL USE.
protected void	setShownOnEDT(boolean shown) INTERNAL USE.
protected void	setShownOnEDT(boolean shown, String field) INTERNAL USE.
int	setState(int state) Sets the current state of this node.
protected int	setState(int state, boolean override) Sets the state of this target.
protected void	setStyleOnEDT(Color foreground, Color background) INTERNAL USE.
void	visitBranch(Visitor<ObjectSelectionNode> visitor) Visit all nodes in this branch

Methods inherited from class java.lang.Object

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

Methods inherited from interface no.g9.client.support.ObjectSelectionNode

addChild, callCheckChangeHook, callCheckClearHook, callCheckCloseHook, callCheckDeleteHook, callCheckFindHook, callCheckRowSelectHook, callCheckSaveHook, callHookBeforeDisplay, clear, clear, clearKeepKeys, display, getChangedFields, getChangedKeyFields, getChildren, getController, getParentNode, getRepresentingClass, getRoleName, hasFocus, hasOneValue, hasValue, hasValue, isConsistant, isEnabled, isEnabled, isShown, isShown, obtain, obtainAsObject, osDisplay, recursiveObtainObject, recursiveObtainObject, resetFields, setChanged, setChanged, setEnabled, setEnabled, setFocus, setParentNode, setShown, setShown, setShowZero, setStyle

Field Detail

objectProxy

protected DomainObjectProxy objectProxy

The object proxy representing the domain object

Constructor Detail

AbstractNode

public AbstractNode()

Method Detail

getChangedNoKeyFields

public Set getChangedNoKeyFields()

Description copied from interface: ObjectSelectionNode

Returns a set containing all fields that have changed since the initial display and wich are not part of the key, in other words the complement of the set derived by getChangedKeyFields

Specified by:

getChangedNoKeyFields in interface ObjectSelectionNode

Returns:

a set containing all changed, non-key, fields.

setState

public int setState(int state)

Description copied from interface: ObjectSelectionNode

Sets the current state of this node. The state should be one of the constants CLEARED, EDITED, CLEAN or DIRTY. Note that setting this state will affect the possible outcomes of invoking ObjectSelectionNode.getState().

Specified by:

setState in interface ObjectSelectionNode

Parameters:

state - the new state to set.

Returns:

the state that was calculated based on the specified state value.

clearOnEDT

protected void clearOnEDT()

INTERNAL USE. Clears the object selection role on edt

clearKeepKeysOnEDT

protected void clearKeepKeysOnEDT()

INTERNAL USE. Clears on edt

See Also:

ObjectSelectionNode.clearKeepKeys()

clearOnEDT

protected void clearOnEDT(String s)

INTERNAL USE. Clears the specified field on the EDT

Parameters:

s - the field to clear

append

public abstract void append(T domainInstance,
                            String field)

Appends the value from the specified field (if possible) to the corresponding text area.

Parameters:

domainInstance - the domain instance with the field value to append

field - the field

appendOnEDT

protected void appendOnEDT(T domainInstance,
                           String field)

INTERNAL USE. Appends on edt

Parameters:

domainInstance - the domain instance

field - the field

See Also:

append(Object, String)

setState

protected int setState(int state,
                       boolean override)

Sets the state of this target. If the second parameter is true the state is overridden, and the state is not calculated when invoking getState().

Parameters:

state - the state to set.

override - if true the state is overridden

Returns:

the new state of this target

getState

public int getState()

Description copied from interface: ObjectSelectionNode

Returns the current state of this node. The state is either CLEARED, EDITED, CLEAN or DIRTY, see constants for details. The transformation between states are as follows:

• CLEARED -> EDITED -> CLEARED (user altered / unaltered data)
• CLEARED -> CLEAN (data displayed)
• EDITED -> CLEAN (data inserted then displayed)
• CLEAN -> DIRTY -> CLEAN (user altered / unaltered data)
• DIRTY -> CLEAN (data updated then displayed)

Specified by:

getState in interface ObjectSelectionNode

Returns:

the current state of this node.

recursiveDisplay

public void recursiveDisplay(Collection domainObjectCollection)

Displays the Set of domain objects. This method will be overridden by classes capable of displaying several instances of the domain object. In other cases the method does nothing.

Parameters:

domainObjectCollection - the collection of objects to display

displayOnEDT

protected void displayOnEDT(Object domainInstance)

INTERNAL USE. Invokes display on edt

Parameters:

domainInstance - the domain instance to display

displayOnEDT

protected void displayOnEDT(String attributeName,
                            Object value,
                            boolean resetState)

INTERNAL USE. Invokes display on edt

Parameters:

attributeName - the name of the attribute to display

value - the value of the attribute to display

resetState - flag - if true state is reset

display

public abstract void display(String attributeName,
                             Object value,
                             boolean resetState)

Updates data of given attriubte in object selection in the dialog.

Parameters:

attributeName - Name of attribute to update.

value - The new value.

resetState - Set to false to avoid resetting the attribute state.

displayOnEDT

public void displayOnEDT(Collection resultObject,
                         List pathToTarget,
                         boolean findAll)

Description copied from interface: ObjectSelectionNode

Performs a recursive display. The display is performed on the EDT. If the invoking thread is not the EDT, the thread is paused while the display is performed.

Specified by:

displayOnEDT in interface ObjectSelectionNode

Parameters:

resultObject - a collection of domain objects

pathToTarget - the path to the target node

findAll - true if the display is a result of a find all action.

displayAboveTarget

public abstract void displayAboveTarget(Collection resultObject,
                                        List pathToTarget,
                                        boolean findAll)

Description copied from interface: ObjectSelectionNode

Displays the collection of domain objects.

Specified by:

displayAboveTarget in interface ObjectSelectionNode

Parameters:

resultObject - the domain objects to display

pathToTarget - the path to the target node

findAll - if true the display is invoked as part of a find all action.

obtainSet

@Deprecated
public Set obtainSet()

Deprecated. use obtainSet(boolean)

Obtains the Set of domain objects. This method will be overridden by classes which are represented as several instances in the dialog (e.g. a list block).

Returns:

a Set of objects.

display

public abstract void display(T domainInstance,
                             String attributeName,
                             boolean resetState)

Updates data of given attriubte in object selection in the dialog.

Parameters:

domainInstance - Attributes are copied from this object.

attributeName - The attribute to set.

resetState - Set to false to avoid resetting the attribute state.

displayOnEDT

protected void displayOnEDT(T domainInstance,
                            String attributeName,
                            boolean resetState)

INTERNAL USE. Displays on edt

Parameters:

domainInstance - (missing javadoc)

attributeName - (missing javadoc)

resetState - (missing javadoc)

See Also:

display(Object, String, boolean)

setFocusOnEDT

protected void setFocusOnEDT(String field)

INTERNAL USE. Sets focus on edt.

Parameters:

field - (missing javadoc)

See Also:

ObjectSelectionNode.setFocus(String)

setShownOnEDT

protected void setShownOnEDT(boolean shown)

INTERNAL USE. setShown on edt

Parameters:

shown - (missing javadoc)

See Also:

ObjectSelectionNode.setShown(boolean)

setShownOnEDT

protected void setShownOnEDT(boolean shown,
                             String field)

INTERNAL USE. setShown on edt

Parameters:

shown - (missing javadoc)

field - (missing javadoc)

See Also:

ObjectSelectionNode.setShown(boolean, String)

setEnabledOnEDT

protected void setEnabledOnEDT(boolean enable,
                               String field)

INTERNAL USE. Enables field on edt.

Parameters:

enable - (missing javadoc)

field - (missing javadoc)

See Also:

ObjectSelectionNode.setEnabled(boolean, String)

setEnabledOnEDT

protected void setEnabledOnEDT(boolean enable)

INTERNAL USE. Enables field on edt

Parameters:

enable - (missing javadoc)

See Also:

ObjectSelectionNode.setEnabled(boolean)

setStyleOnEDT

protected void setStyleOnEDT(Color foreground,
                             Color background)

INTERNAL USE. Sets the style on edt

Parameters:

foreground - (missing javadoc)

background - (missing javadoc)

See Also:

ObjectSelectionNode.setStyle(Color, Color)

obtainSet

public Set obtainSet(boolean createIfNull)

Obtains a set of domain objects. This method will be overridden by classes which are represented as several instances in the dialog (e.g. a list block). Note that invoking this method has a side effect in the case of listblocks if createIfNull flag is true: If a listblock line holds a null-reference to a domain instance, a new object will be created by the listblock line.

Specified by:

obtainSet in interface ObjectSelectionNode

Parameters:

createIfNull - flag indicating if missing objects should be created.

Returns:

a Set of objects

See Also:

ListblockLine.getObject(String, boolean)

nullProxy

public void nullProxy()

Recursivly releases the proxy on this target. The effect is that the connection to the original domain object (as returned from the server) is lost, an subsequent obtains will return a new instance of the domain object, with only attributes from the dialog set.

checkFind

public boolean checkFind()

Description copied from interface: ObjectSelectionNode

If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with find action. The following conditions are checked:

1. No data fields in this node, exept key-fields, are changed
2. No fields in child-nodes (recursivly) are changed.

If these conditions are met, the return value is true. Otherwise, a modal dialog is shown and the user (of the application) is asked wether to proceed or not. If the user answers yes, the returned value is true.

Specified by:

checkFind in interface ObjectSelectionNode

Returns:

true if it's ok to proceed with find.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkRowSelection

public boolean checkRowSelection(int oldSelection,
                                 int newSelection)

Description copied from interface: ObjectSelectionNode

If the controller's ignoreCheckChange property is false, determine if it is ok to proceed to change the selected row in a listblock.

Specified by:

checkRowSelection in interface ObjectSelectionNode

Parameters:

oldSelection - the index of the old selection

newSelection - the index of the new selection

Returns:

true if it is ok to proceed.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkRowSelection

public boolean checkRowSelection(int oldSelection,
                                 int newSelection,
                                 Set foreignNodes)

Parameters:

oldSelection - (missing javadoc)

newSelection - (missing javadoc)

foreignNodes - (missing javadoc)

Returns:

(missing javadoc)

checkPrint

public boolean checkPrint()

Returns:

(missing javadoc)

checkClose

public boolean checkClose()

Description copied from interface: ObjectSelectionNode

If the dialog controllers Determin if it is ok to proceed with action close window. If he dialog does not contain any changed data since it's last display, the return value is true. Otherwise, a modal dialog is shown and the user (of the application) is asked wether to proceed or not. If the user answers "yes", the return value is true .

Specified by:

checkClose in interface ObjectSelectionNode

Returns:

true if it's ok to proceed with close.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkDelete

public boolean checkDelete()

Description copied from interface: ObjectSelectionNode

If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action delete. If he dialog does not contain any changed data since it's last display, the return value is true. Otherwise, a modal dialog is shown and the user (of the application) is asked wether to proceed or not. If the user answers "yes", the return value is true.

Specified by:

checkDelete in interface ObjectSelectionNode

Returns:

true if it's ok to proceed with delte.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkClear

public boolean checkClear()

Description copied from interface: ObjectSelectionNode

If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action clear. If the dialog does not contain any changed data since it's last display, the return value is true. Otherwise, a model dialog is shown and the user (of the application) is asked wether to proceed or not. If the user answers "yes", the return value is true.

Specified by:

checkClear in interface ObjectSelectionNode

Returns:

true if it's ok to proceed with delete. *

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkSave

public boolean checkSave()

Description copied from interface: ObjectSelectionNode

If the controller's ignoreCheckChange property is false, determin if it is ok to proceed with action save. No specific check is perfomed, but a hook is called for each node involved in the save action (the sequence is from the top of the object selection). The returned value from this method is always true, and the return value from the specific hook methods are used to determin wether to proceed with the check save or not.

Specified by:

checkSave in interface ObjectSelectionNode

Returns:

true if it is ok to proceed with action save.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkChanged

public boolean checkChanged()

Description copied from interface: ObjectSelectionNode

If the dialog controllers ignoreCheckChange is false this method checks if the node (with children) is unchanged. To things are considered:

1. First the currently displayed attribute values are compared against the initially displayed attribute value. If all displayed values equals the original diaplayed value (thus it is not changed by a user) the check continues to the next face, otherwise it returns false.

   This is done recursivly, thus the first node checked is a leaf-node.

2. If the current node being checked is an up-related node, the relation to the parent is checked. If the currently displayed (up-related) node differs from the parent's child node, the return value is false

Specified by:

checkChanged in interface ObjectSelectionNode

Returns:

true if no fields are changed and all up-related relations are intact.

See Also:

G9DialogController.setIgnoreCheckChanged(boolean)

checkChangedAsChild

public boolean checkChangedAsChild()

Recursivly calls check change and then checks the integrity of the relation of this target and the parent target if the target is up-related.

Returns:

true if fields and relations are intact.

getEmptyDomainObject

public abstract Object getEmptyDomainObject()

Returns an empty instance of the domain object represented by this object selection target.

Returns:

an empty instance of the domain object

peekAtObject

public Object peekAtObject()

Returns a shallow copy of the domain object, where attributes are read from the dialog.

Specified by:

peekAtObject in interface ObjectSelectionNode

Returns:

an object where attributes are read from the dialog

getProxy

public DomainObjectProxy getProxy()

Retuns the domain object proxy for this target. If no such proxy exist, a new is created.

Returns:

the domain object proxy

display

public abstract void display(String attributeName,
                             Object value)

Displays the specified attribute value. Displayed value might be considered changed if the markIfChanged parameter is true.

Parameters:

attributeName - the name of the attribute

value - the value to display

getPathToNode

public List<AbstractNode> getPathToNode()

Description copied from interface: ObjectSelectionNode

Returns the path from the root node to this node.

Specified by:

getPathToNode in interface ObjectSelectionNode

Returns:

a List of nodes representing the path to this node.

getRootNode

public ObjectSelectionNode getRootNode()

Description copied from interface: ObjectSelectionNode

Returns the root node of this object selection node.

Specified by:

getRootNode in interface ObjectSelectionNode

Returns:

the root node in the object selection.

isRootNode

public boolean isRootNode()

Check if this is a root node and if so, return true

Returns:

true if this is a root node

getAllChildNames

public Set getAllChildNames()

Returns a Set of Strings containing the names of all children (recursively).

Returns:

the children's names.

mergeAssociations

public abstract void mergeAssociations(Object domainObject,
                                       List pathToTarget,
                                       boolean error)

Internal use.

Merge the associations from the specified domain object with the stored associations. This is done after return from a server action.

Before the object tree is sent to the server, all objects not on path to target (and not up-related) are stripped away and stored in order to reduce network traffic. This method restores the associations, merging the result from the server with the stored associations.

Parameters:

domainObject - the domain object

pathToTarget - the path to the target target.

error - true if rhe merge is after an error situation

saveAssociation

protected void saveAssociation(String roleName,
                               Object domainObject,
                               Object association)

Internal use.

Saves the association

Parameters:

roleName - the role name of the domain object's association

domainObject - the domain object

association - the association

See Also:

mergeAssociations(Object, List, boolean)

getAssociation

protected Object getAssociation(String roleName,
                                Object domainObject)

Internal use.

Gets the stored association with the specified role name belonging to the specified domain object.

Parameters:

roleName - the role name of the association

domainObject - the domain object the association belongs to

Returns:

the association

removeFromParent

public void removeFromParent(Object root)

Internal use. Removes the specified role instance from the stored set of instances.

Parameters:

root - the root instance.

getRoleNameToAssociationMap

public Map getRoleNameToAssociationMap()

Experimental. Application programmers should NOT!!! invoke this method.

Returns:

map of role names to associations

clearAllAssociation

protected void clearAllAssociation()

Clears all associations for the role.

addToAssociation

protected void addToAssociation(String roleName,
                                Object domainObject,
                                Set association)

Internal use

Adds the specified association to the stored associations

Parameters:

roleName - the role name of the association

domainObject - the domain object with the association

association - the association

resetAssociations

public void resetAssociations(Object o)

Internal use. Restores the associations for a given root target. Used internally after a find action on a sub-branch of the object selection.

Parameters:

o - the domain object for which to restore associations.

isChanged

public boolean isChanged(String attributeName)
                  throws G9ClientException

Description copied from interface: ObjectSelectionNode

Check if the specified attribute is changed. The attribute is changed if the user has edited the field representing the attribute, and the contents of the field is different from the originally displayed contents. The attribute can be specifed as either the attribute name, or prefixed with the role-name (e.g. "id" or "Role.id"). If the specified attribute is not found, a G9ClientException is thrown.

Specified by:

isChanged in interface ObjectSelectionNode

Parameters:

attributeName - the name of the attribute

Returns:

true if the field has changed, otherwise false .

Throws:

G9ClientException - if the attribute is not part of this role.

See Also:

getChangedNoKeyFields(), ObjectSelectionNode.getChangedKeyFields(), ObjectSelectionNode.getChangedFields()

inListblock

public boolean inListblock()

Returns true if this role is a listblock role.

Specified by:

inListblock in interface ObjectSelectionNode

Returns:

true if this is a listblock role.

setAssociation

protected abstract void setAssociation(Object self,
                                       String associationRoleName,
                                       Object association)

Internal use. Application programmers should not use this method as it might change in incompatible ways between releases or even patches. Sets an association from self to the association with the role assocationRoleName.

Parameters:

self - the object to set the association from

associationRoleName - the association name

association - the association instance.

isNavigableToParent

public abstract boolean isNavigableToParent()

Internal use. Application programmers should not use this method as it might change in incompatible ways between releases or even patches. Check if the role is navigable to parent.

Returns:

true if role is navigable to parent.

greedyObtain

public Object greedyObtain()

Internal use. Application programmers should not use this method as it might change in incompatible ways between releases or even patches. Obtains the role. If it is in a listblock, all instances are obtained, and a set of domain instances are returned. Otherwise, recursively obtains "self" and children unless the node (and all its children) is in the CLEARED state.

Specified by:

greedyObtain in interface ObjectSelectionNode

Returns:

the obtained instance or instances

accept

public void accept(Visitor<ObjectSelectionNode> visitor)

Specified by:

accept in interface Visitable<ObjectSelectionNode>

visitBranch

public void visitBranch(Visitor<ObjectSelectionNode> visitor)

Description copied from interface: ObjectSelectionNode

Visit all nodes in this branch

Specified by:

visitBranch in interface ObjectSelectionNode

Parameters:

visitor - the visitor that gets the visit callback.