org.midica.ui.model

Class MessageTreeNode

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

org.midica.ui.model.MidicaTreeNode

org.midica.ui.model.MessageTreeNode

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode, IMessageType

public class MessageTreeNode
extends MidicaTreeNode
implements IMessageType

This class represents a node for a MidicaTree containing MIDI message types.

It implements IMessageType so that it’s content can be displayed in the message detail panel. Therefore it contains methods to store and retrieve message detail information.

Author:

Jan Trukenmüller

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap<java.lang.Integer,java.util.TreeSet<java.lang.Comparable<?>>>	distinctOptions stores multiple values of the same ID
private java.util.HashMap<java.lang.Integer,java.lang.Comparable<?>>	maxOptions stores the maximum custom node options
private java.util.HashMap<java.lang.Integer,java.lang.Comparable<?>>	minOptions stores the minimum custom node options
private java.util.HashMap<java.lang.Integer,java.lang.Object>	options can be used to store custom node options
private static long	serialVersionUID

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Fields inherited from interface org.midica.ui.model.IMessageType

OPT_CHANNEL, OPT_CONTROLLER, OPT_LEAF_NODE, OPT_LENGTH, OPT_MESSAGE, OPT_META_TYPE, OPT_MSG_NUM, OPT_NRPN, OPT_RPN, OPT_STATUS_BYTE, OPT_SUB_ID_1, OPT_SUB_ID_2, OPT_SUMMARY, OPT_SYSEX_CHANNEL, OPT_TEMPO_BPM, OPT_TEMPO_MPQ, OPT_TEXT, OPT_TICK, OPT_TRACK, OPT_VENDOR_ID, OPT_VENDOR_NAME, OPTIONS

Constructor Summary

Constructors

Constructor and Description
MessageTreeNode() Creates a new node with an empty name.
MessageTreeNode(java.lang.String name) Creates a new node with the given text but without a number.
MessageTreeNode(java.lang.String name, java.lang.String number) Creates a new node with the given text and number.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDistinctOptions(int id) Returns all distinct options that have been added with the given ID.
java.lang.String	getDistinctOptions(int id, java.lang.String separator) Returns all distinct options that have been added with the given ID.
java.lang.Object	getOption(int id) Returns the custom node option that has been set with the last call to setOption(int, Object) with the given ID.
java.lang.String	getRange(int id) Returns the range of values that has been set by calling setOption(int, Object) with the given ID.
void	setDistinctOption(int id, java.lang.Comparable<?> value) Sets options to be stored permanently.
void	setOption(int id, java.lang.Object value) Sets custom node options.

Methods inherited from class org.midica.ui.model.MidicaTreeNode

addAndOrIncrement, addChildren, attachToToolTip, getId, getName, getNumber, getToolTip, increment, initChildren, setId, setName, setNumber, toString

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

options

private java.util.HashMap<java.lang.Integer,java.lang.Object> options

can be used to store custom node options

minOptions

private java.util.HashMap<java.lang.Integer,java.lang.Comparable<?>> minOptions

stores the minimum custom node options

maxOptions

private java.util.HashMap<java.lang.Integer,java.lang.Comparable<?>> maxOptions

stores the maximum custom node options

distinctOptions

private java.util.HashMap<java.lang.Integer,java.util.TreeSet<java.lang.Comparable<?>>> distinctOptions

stores multiple values of the same ID

Constructor Detail

MessageTreeNode

public MessageTreeNode(java.lang.String name,
                       java.lang.String number)

Creates a new node with the given text and number.

Parameters:

name - Main text to be displayed.

number - MIDI number representing this node.

MessageTreeNode

public MessageTreeNode(java.lang.String name)

Creates a new node with the given text but without a number.

Parameters:

name - Main text to be displayed.

MessageTreeNode

public MessageTreeNode()

Creates a new node with an empty name.

This constructor is used indirectly from the MidicaTreeModel and from MidicaTreeNode by calling newInstance() on the class object. So the node name or number must be set later with MidicaTreeNode.setName(String) or MidicaTreeNode.setNumber(String).

Method Detail

setOption

public void setOption(int id,
                      java.lang.Object value)

Sets custom node options.

If the option value is comparable, remembers the minimum and maximum of all calls to this method with the same id.

These values can be retrieved later with getOption(int).

Parameters:

id - The option ID.

value - The option value.

getOption

public java.lang.Object getOption(int id)

Returns the custom node option that has been set with the last call to setOption(int, Object) with the given ID.

Returns null, if no option of the given ID exists.

Specified by:

getOption in interface IMessageType

Parameters:

id - The option ID.

Returns:

the option value or null if not available.

getRange

public java.lang.String getRange(int id)

Returns the range of values that has been set by calling setOption(int, Object) with the given ID.

Returns null, if no values have been set or the values are not Comparable.

Returns only one value, if the minimum and maximum values are identical.

Otherwise: Returns the range in the form min - max.

Specified by:

getRange in interface IMessageType

Parameters:

id - The option ID.

Returns:

the option’s range or value or null, like described above.

setDistinctOption

public void setDistinctOption(int id,
                              java.lang.Comparable<?> value)

Sets options to be stored permanently.

If this method is called several times with the same ID, the according value is only stored if not yet done.

The values can be retrieved later with getDistinctOptions(int)

The following data types are allowed for the value:

• String
• Byte
• Integer
• Long

Parameters:

id - The option ID.

value - The option value (must be a string or a number object).

getDistinctOptions

public java.lang.String getDistinctOptions(int id)

Returns all distinct options that have been added with the given ID.

Returns null, if no distinct options with this ID have been added.

Same as getDistinctOptions(int, String) using "**, **" as the separator.

Specified by:

getDistinctOptions in interface IMessageType

Parameters:

id - The option ID.

Returns:

the option values, if available. Otherwise: null.

getDistinctOptions

public java.lang.String getDistinctOptions(int id,
                                           java.lang.String separator)

Returns all distinct options that have been added with the given ID.

Returns null, if no distinct options with this ID have been added.

Specified by:

getDistinctOptions in interface IMessageType

Parameters:

id - The option ID.

separator - The string to be used in order to separate the values.

Returns:

the option values, if available. Otherwise: null.