curam.contextviewer.impl

Class ContextNode

java.lang.Object

curam.contextviewer.impl.ContextNode

All Implemented Interfaces:

curam.contextviewer.impl.IContextLoaderProvider, IContextNode, java.lang.Comparable<IContextNode>

@AccessLevel(value=EXTERNAL)
public abstract class ContextNode
extends java.lang.Object
implements IContextNode, java.lang.Comparable<IContextNode>, curam.contextviewer.impl.IContextLoaderProvider

This class must be extended by loader implementations that require to have content displayed on the Context Viewer. Default functionality is provided for loaders

Constructor Summary

Constructors

Constructor and Description
ContextNode() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addChild(IContextNode citizenContextNode) Adds a CitizenContextNode implementation as a child.
void	addDefaultChild(IContextNode defaultNode, java.lang.String childLabel) Adds a default child using the childLabel param as the label for the child node.
int	compareTo(IContextNode o)
java.util.Set<IContextNode>	getChildren() Gets the children of the current node.
java.lang.String	getContextID() Returns the context id to be used when identifying the context item on the Citizen Context tree.
java.util.HashMap<java.lang.String,java.lang.String>	getExtraData() Gets the extra data that can be used by the context tree.
IContextNode	getInstance()
java.lang.String	getLabel() Returns the localized label to be used when displaying this node on the Citizen Context tree.
java.lang.String	getNodeType() Returns the node type ID for this node.
int	getUnsecureCount() Returns the number of instances of this node that are unavailable due to security checks.
abstract IContextNode	load(curam.contextviewer.facade.struct.Context_ID contextID) Loads this node with the Data required to display the Citizen Context tree.
void	setContextID(java.lang.String contextID) Sets the context id for the node.
void	setExtraData(java.lang.String attributeName, java.lang.String attributeValue) Sets the extra data that can be used by the context tree.
void	setLabel(java.lang.String label) Sets the label for the node.
void	setLabelAllNotShown(java.lang.String label, int numberOfChildrenNotShown) Sets the label for the node when all children are not shown.
void	setLabelIncludingChildren(java.lang.String label, int numberOfChildren) Sets the label for the node including the number of children for the node.
void	setLabelIncludingNotShown(java.lang.String label, int numberOfChildren, int numberOfChildrenNotShown) Sets the label for the node including the number of children for the node and the number of children not shown.
void	setNodeType(java.lang.String citizenContextNodeTypeID) Sets the node type id to be used for this node.
void	setUnsecureCount(int unsecureCount) Sets the number of nodes that are unavailable due to security checks.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextNode

public ContextNode()

Default constructor.

Method Detail

load

public abstract IContextNode load(curam.contextviewer.facade.struct.Context_ID contextID)
                           throws curam.util.exception.AppException,
                                  curam.util.exception.InformationalException

Loads this node with the Data required to display the Citizen Context tree.

Specified by:

load in interface IContextNode

Parameters:

contextID - - the concern role id of the citizen.

Returns:

CitizenContextNode. The root node object.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

addChild

public void addChild(IContextNode citizenContextNode)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Adds a CitizenContextNode implementation as a child.

Specified by:

addChild in interface IContextNode

Parameters:

citizenContextNode - - the child node to be added.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

addDefaultChild

public void addDefaultChild(IContextNode defaultNode,
                            java.lang.String childLabel)
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Adds a default child using the childLabel param as the label for the child node.

Specified by:

addDefaultChild in interface IContextNode

Parameters:

defaultNode - The default child

childLabel - The label to use for the child node

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getChildren

public java.util.Set<IContextNode> getChildren()
                                        throws curam.util.exception.AppException,
                                               curam.util.exception.InformationalException

Gets the children of the current node.

Specified by:

getChildren in interface IContextNode

Returns:

Iterator holding the child node objects.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setContextID

public void setContextID(java.lang.String contextID)
                  throws curam.util.exception.AppException,
                         curam.util.exception.InformationalException

Sets the context id for the node.

Specified by:

setContextID in interface IContextNode

Parameters:

contextID - This is passed as an attribute on the context tree.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getContextID

public java.lang.String getContextID()
                              throws curam.util.exception.AppException,
                                     curam.util.exception.InformationalException

Returns the context id to be used when identifying the context item on the Citizen Context tree.

Specified by:

getContextID in interface IContextNode

Returns:

The context id to be used when identifying the context item on the Citizen Context tree.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setLabel

public void setLabel(java.lang.String label)
              throws curam.util.exception.AppException,
                     curam.util.exception.InformationalException

Sets the label for the node. The label can be a textual description or a codetable value where localization is to be considered.

Specified by:

setLabel in interface IContextNode

Parameters:

label - This is displayed on the Citizen Context Viewer tree.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setLabelIncludingChildren

public void setLabelIncludingChildren(java.lang.String label,
                                      int numberOfChildren)
                               throws curam.util.exception.AppException,
                                      curam.util.exception.InformationalException

Sets the label for the node including the number of children for the node. The label can be a textual description or a codetable value where localization is to be considered.

Specified by:

setLabelIncludingChildren in interface IContextNode

Parameters:

label - This is displayed on the Citizen Context Viewer tree.

numberOfChildren - The number of children to be displayed in the label

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setLabelAllNotShown

public void setLabelAllNotShown(java.lang.String label,
                                int numberOfChildrenNotShown)
                         throws curam.util.exception.AppException,
                                curam.util.exception.InformationalException

Sets the label for the node when all children are not shown. The label can be a textual description or a codetable value where localization is to be considered.

Specified by:

setLabelAllNotShown in interface IContextNode

Parameters:

label - This is displayed on the Citizen Context Viewer tree.

numberOfChildrenNotShown - The number of children not displayed in the label

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setLabelIncludingNotShown

public void setLabelIncludingNotShown(java.lang.String label,
                                      int numberOfChildren,
                                      int numberOfChildrenNotShown)
                               throws curam.util.exception.AppException,
                                      curam.util.exception.InformationalException

Sets the label for the node including the number of children for the node and the number of children not shown. The label can be a textual description or a codetable value where localization is to be considered.

Specified by:

setLabelIncludingNotShown in interface IContextNode

Parameters:

label - This is displayed on the Citizen Context Viewer tree.

numberOfChildren - The number of children to be displayed in the label

numberOfChildrenNotShown - The number of children not displayed in the label

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getLabel

public java.lang.String getLabel()
                          throws curam.util.exception.AppException,
                                 curam.util.exception.InformationalException

Returns the localized label to be used when displaying this node on the Citizen Context tree.

Specified by:

getLabel in interface IContextNode

Returns:

The localized label to be used when displaying this node on the Citizen Context tree.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setNodeType

public void setNodeType(java.lang.String citizenContextNodeTypeID)
                 throws curam.util.exception.AppException,
                        curam.util.exception.InformationalException

Sets the node type id to be used for this node. The node type contains information describing the nature of the node in it's Citizen Context tree.

Specified by:

setNodeType in interface IContextNode

Parameters:

citizenContextNodeTypeID - - The ID of the node type to be used for this node.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getNodeType

public java.lang.String getNodeType()
                             throws curam.util.exception.AppException,
                                    curam.util.exception.InformationalException

Returns the node type ID for this node.

Specified by:

getNodeType in interface IContextNode

Returns:

The node type ID for this node.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

compareTo

public int compareTo(IContextNode o)

Specified by:

compareTo in interface java.lang.Comparable<IContextNode>

setUnsecureCount

public void setUnsecureCount(int unsecureCount)
                      throws curam.util.exception.AppException,
                             curam.util.exception.InformationalException

Sets the number of nodes that are unavailable due to security checks.

Specified by:

setUnsecureCount in interface IContextNode

Parameters:

unsecureCount - number of nodes that are unavailable due to security checks.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getUnsecureCount

public int getUnsecureCount()
                     throws curam.util.exception.AppException,
                            curam.util.exception.InformationalException

Returns the number of instances of this node that are unavailable due to security checks.

Specified by:

getUnsecureCount in interface IContextNode

Returns:

The number of instances of this node that are unavailable due to security checks

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

setExtraData

public void setExtraData(java.lang.String attributeName,
                         java.lang.String attributeValue)
                  throws curam.util.exception.AppException,
                         curam.util.exception.InformationalException

Sets the extra data that can be used by the context tree. Typical use is to allow interaction with other client side data display widgets.

Specified by:

setExtraData in interface IContextNode

Parameters:

attributeName - Name of the extra data attributes

attributeValue - Value of the extra data attributes

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getExtraData

public java.util.HashMap<java.lang.String,java.lang.String> getExtraData()
                                                                  throws curam.util.exception.AppException,
                                                                         curam.util.exception.InformationalException

Gets the extra data that can be used by the context tree. Typical use is to allow interaction with other client side data display widgets.

Specified by:

getExtraData in interface IContextNode

Returns:

HashMap Name and value pairs for the extra data attributes.

Throws:

curam.util.exception.AppException - Generic Exception Signature.

curam.util.exception.InformationalException - Generic Exception Signature.

getInstance

public IContextNode getInstance()

Specified by:

getInstance in interface curam.contextviewer.impl.IContextLoaderProvider