com.highqsoft.p2d

Class P2DMarkerGroup

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

com.highqsoft.fwk.FwkItem

com.highqsoft.fwk.FwkInfoBusMember

com.highqsoft.p2d.P2DMarkerGroup

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInfoBusMemberInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkPropertyChangeListenerInterface, FwkTransferableInterface, FwkVetoableChangeInterface, P2DMarkerGroupInterface, P2DRangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.beans.PropertyChangeListener, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.EventListener, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.ImmediateAccess, javax.infobus.InfoBusMember

public class P2DMarkerGroup
extends FwkInfoBusMember
implements P2DMarkerGroupInterface

The P2DMarkerGroup.

Since:

$Date: 2017/04/06 13:30:08 $

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static FwkDescriptionInterface	descriptor
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkInfoBusMember

infoBusMemberSupport

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, properties, suspendChangeManager

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.p2d.P2DMarkerGroupInterface

CENTER, LOWER, UPPER

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

INFOBUS_SOURCE

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
P2DMarkerGroup(java.lang.String name) The default constructor.
P2DMarkerGroup(java.lang.String name, double lower, double upper) The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addChild(FwkInfoBusItemGroupInterface child) Add a child to group.
void	addChildListener(FwkChildListenerInterface l) Add a child listener.
boolean	containsChild(FwkInfoBusItemGroupInterface child) Return a boolean whether the given child is already in group.
protected int	findChild(java.lang.String name) Find a child.
P2DMarkerGroupInterface	findMarkerGroup(double value, java.lang.String bColumn, double tolerance) Find a marker with the given tolerance.
FwkArrayInterface	getAllChildren() Returns the children of the group.
FwkArrayInterface	getAllChildren(FwkArrayInterface arr) Returns the children of the group.
java.lang.String	getBoundColumn() Get the name of the bounded column.
FwkArrayInterface	getChildren() Returns the children of the group.
FwkArrayInterface	getChildren(FwkArrayInterface array) Returns the children of the group.
int	getChildrenCount(boolean recursive) Return the total number of children.
java.awt.Color	getColor() Get the current color of the marker.
FwkCommandInterface[]	getCommands() Get commands.
static FwkDescriptionInterface	getDescriptor()
long	getLowerIndex() Returns the lower value index of the marker.
long	getLowerIndex(java.lang.String colName) Returns the lower value index of the marker.
double	getLowerLimit() Returns the lower value of the marker.
int	getMarker() get the marker falg.
P2DRange1DInterface	getRange() Returns the effective range of the marker.
long[]	getRangeIndex() Returns the index range of the marker.
long[]	getRangeIndex(java.lang.String colName) Returns the upper value index of the marker.
java.lang.String	getUnit() Get unit string.
long	getUpperIndex() Returns the upper value index of the marker.
long	getUpperIndex(java.lang.String colName) Returns the upper value index of the marker.
double	getUpperLimit() Returns the upper value of the marker.
java.lang.Object	getValueAsObject() Get the value as object.
java.lang.String	getValueAsString() Get the vale as string.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	hasChildren() Returns a boolean that indicates whether the group has children.
boolean	hasValidValues() Returns a boolean whether the item has valid values.
boolean	isGroup() Returns a boolean that indicates whether the item is a group.
void	propertyChange(java.beans.PropertyChangeEvent ev) Revoked when a property changed.
void	removeAllChildren() Remove all children from group.
void	removeChild(FwkInfoBusItemGroupInterface child) Remove a child to group.
void	removeChild(FwkInfoBusItemGroupInterface child, boolean recursive) Remove a child recursively from group.
void	removeChildListener(FwkChildListenerInterface l) Remove a child listener.
void	set(double value) Sets the value that is marked.
void	setArea(double lower, double upper) Set the area of the marker.
void	setBoundColumn(java.lang.String columnName) Bind the marker to a specific column.
void	setChildren(FwkArrayInterface array) Sets the children of the group.
void	setColor(java.awt.Color c) Set the color of the marker.
void	setLowerLimit(double lower) Set the lower value of the marker.
void	setMarker(int marker) Set the marker.
void	setRange(double lower, double upper) Set the range.
void	setRange(P2DRange1DInterface range) Set the range.
void	setUpperLimit(double upper) Set the upper value of the marker.
void	setValid(boolean flag) Set the group valid flag.
void	setValidValues(boolean flag) Set the flag for valid values.
void	setValue(java.lang.Object col) Set the value of the item.
void	unregister() Unregister the marker group from producer.

Methods inherited from class com.highqsoft.fwk.FwkInfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, finalize, getInfoBus, getInfoBusName, getMemberName, isConnected, joinInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus, setInfoBusName, setMemberName, setName

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, release, removeDataItemChangeListener, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from class com.highqsoft.fwk.FwkPersistence

addCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCommands, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleName

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusMemberInterface

getInfoBusName, getMemberName, isConnected, setInfoBusName, setMemberName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkItemInterface

fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getProperty, getPropertyGroup, setProperty, setPropertyGroup, suspendChangeManager

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPersistenceInterface

getCommands, getPersistentObjectNames

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkVetoableChangeInterface

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface javax.infobus.DataItem

getSource, release

Methods inherited from interface javax.infobus.InfoBusMember

addInfoBusPropertyListener, addInfoBusVetoableListener, getInfoBus, removeInfoBusPropertyListener, removeInfoBusVetoableListener, setInfoBus

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInfoBusImmediateAccessInterface

getName, setProperty

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

Constructor Detail

P2DMarkerGroup

public P2DMarkerGroup(java.lang.String name)

The default constructor.

Parameters:

name - The name of the group

P2DMarkerGroup

public P2DMarkerGroup(java.lang.String name,
              double lower,
              double upper)

The constructor.

Parameters:

name - The name of the group

lower - the lower value.

upper - the upper value.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkInfoBusMember

getDescriptor

public static FwkDescriptionInterface getDescriptor()

unregister

public void unregister()

Unregister the marker group from producer.

Specified by:

unregister in interface P2DMarkerGroupInterface

getValueAsString

public java.lang.String getValueAsString()

Get the vale as string.

Specified by:

getValueAsString in interface javax.infobus.ImmediateAccess

Returns:

The string value of the item.

setValue

public void setValue(java.lang.Object col)
              throws javax.infobus.InvalidDataException,
                     FwkException

Set the value of the item.

Specified by:

setValue in interface javax.infobus.ImmediateAccess

Parameters:

value - the new value.

Throws:

javax.infobus.InvalidDataException

FwkException

hasValidValues

public boolean hasValidValues()

Returns a boolean whether the item has valid values.

Specified by:

hasValidValues in interface FwkInfoBusImmediateAccessInterface

Specified by:

hasValidValues in interface P2DMarkerGroupInterface

Returns:

true if the values are valid.

setValidValues

public void setValidValues(boolean flag)

Set the flag for valid values.

Specified by:

setValidValues in interface FwkInfoBusImmediateAccessInterface

Parameters:

flag - true if the values should be valid.

getValueAsObject

public java.lang.Object getValueAsObject()

Get the value as object.

Specified by:

getValueAsObject in interface javax.infobus.ImmediateAccess

Returns:

The value object.

getChildrenCount

public int getChildrenCount(boolean recursive)

Return the total number of children.

Specified by:

getChildrenCount in interface FwkInfoBusItemGroupInterface

Parameters:

recursive - if true the counter will parse the child groups.

getChildren

public FwkArrayInterface getChildren()

Returns the children of the group.

Specified by:

getChildren in interface FwkInfoBusItemGroupInterface

Returns:

An array containing the children of the group.

getChildren

public FwkArrayInterface getChildren(FwkArrayInterface array)

Returns the children of the group.

Specified by:

getChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array to store the children. If this parameter is null the routine must create it. The parameter or the newly created array will be returned.

Returns:

the array containing the children.

getAllChildren

public FwkArrayInterface getAllChildren()

Returns the children of the group.

Specified by:

getAllChildren in interface FwkInfoBusItemGroupInterface

Returns:

An array containing the children of the group.

getAllChildren

public FwkArrayInterface getAllChildren(FwkArrayInterface arr)

Returns the children of the group.

Specified by:

getAllChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array to store the recursive children. If this parameter is null the routine must create it. The parameter or the newly created array will be returned.

Returns:

An array containing the children of the group.

hasChildren

public boolean hasChildren()

Returns a boolean that indicates whether the group has children.

Specified by:

hasChildren in interface FwkInfoBusItemGroupInterface

Returns:

true if the group has children.

setChildren

public void setChildren(FwkArrayInterface array)

Sets the children of the group.

Specified by:

setChildren in interface FwkInfoBusItemGroupInterface

Parameters:

array - An array containing the names of children of the group.

addChild

public boolean addChild(FwkInfoBusItemGroupInterface child)

Add a child to group.

Specified by:

addChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

Returns:

true if successful.

containsChild

public boolean containsChild(FwkInfoBusItemGroupInterface child)

Return a boolean whether the given child is already in group.

Specified by:

containsChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - the child to be checked.

Returns:

true if the child is a member of group.

removeChild

public void removeChild(FwkInfoBusItemGroupInterface child)

Remove a child to group.

Specified by:

removeChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

findChild

protected int findChild(java.lang.String name)

Find a child.

Parameters:

name - The name of the component.

Returns:

The index of the component, -1 if not found.

removeChild

public void removeChild(FwkInfoBusItemGroupInterface child,
               boolean recursive)

Remove a child recursively from group.

Specified by:

removeChild in interface FwkInfoBusItemGroupInterface

Parameters:

child - The new child.

removeAllChildren

public void removeAllChildren()

Remove all children from group.

Specified by:

removeAllChildren in interface FwkInfoBusItemGroupInterface

addChildListener

public void addChildListener(FwkChildListenerInterface l)

Add a child listener.

Specified by:

addChildListener in interface FwkInfoBusItemGroupInterface

Parameters:

l - The listener to be added.

removeChildListener

public void removeChildListener(FwkChildListenerInterface l)

Remove a child listener.

Specified by:

removeChildListener in interface FwkInfoBusItemGroupInterface

Parameters:

l - The listener to be removed.

isGroup

public boolean isGroup()

Returns a boolean that indicates whether the item is a group.

Specified by:

isGroup in interface FwkInfoBusImmediateAccessInterface

Returns:

true if the item is group.

getLowerLimit

public double getLowerLimit()

Returns the lower value of the marker.

Specified by:

getLowerLimit in interface P2DRangeInterface

Returns:

the lower value.

getUpperLimit

public double getUpperLimit()

Returns the upper value of the marker.

Specified by:

getUpperLimit in interface P2DRangeInterface

Returns:

the upper value.

getLowerIndex

public long getLowerIndex()

Returns the lower value index of the marker.

Specified by:

getLowerIndex in interface P2DMarkerGroupInterface

Returns:

the lower value index.

getUpperIndex

public long getUpperIndex()

Returns the upper value index of the marker.

Specified by:

getUpperIndex in interface P2DMarkerGroupInterface

Returns:

the upper value index.

getLowerIndex

public long getLowerIndex(java.lang.String colName)

Returns the lower value index of the marker.

Specified by:

getLowerIndex in interface P2DMarkerGroupInterface

Parameters:

colName - The name of the column to that the relative index should be returned. If the column with the specified name was not found then the internal bound column name is used.

Returns:

the lower value index.

getUpperIndex

public long getUpperIndex(java.lang.String colName)

Returns the upper value index of the marker.

Specified by:

getUpperIndex in interface P2DMarkerGroupInterface

Parameters:

colName - The name of the column to that the relative index should be returned. If the column with the specified name was not found then the internal bound column name is used.

Returns:

the upper value index.

getRangeIndex

public long[] getRangeIndex()

Returns the index range of the marker.

Specified by:

getRangeIndex in interface P2DMarkerGroupInterface

Returns:

the index array of the marker range.

getRangeIndex

public long[] getRangeIndex(java.lang.String colName)

Returns the upper value index of the marker.

Specified by:

getRangeIndex in interface P2DMarkerGroupInterface

Parameters:

colName - The name of the column to that the relative index should be returned.

Returns:

the upper value index.

setArea

public void setArea(double lower,
           double upper)

Set the area of the marker.

Specified by:

setArea in interface P2DMarkerGroupInterface

Parameters:

lower - the lower coordinate of the marker.

upper - the upper coordinate of the marker.

setLowerLimit

public void setLowerLimit(double lower)

Set the lower value of the marker.

Specified by:

setLowerLimit in interface P2DRangeInterface

Parameters:

lower - the lower value of the marker.

setUpperLimit

public void setUpperLimit(double upper)

Set the upper value of the marker.

Specified by:

setUpperLimit in interface P2DRangeInterface

Parameters:

upper - the upper value of the marker.

set

public void set(double value)

Sets the value that is marked.

Specified by:

set in interface P2DMarkerGroupInterface

Parameters:

value. -

setMarker

public void setMarker(int marker)

Set the marker.

Specified by:

setMarker in interface P2DMarkerGroupInterface

Parameters:

marker - Use the predefined value from interface or null to erase the marker flag.

marker - The marker flag.

getMarker

public int getMarker()

get the marker falg.

Specified by:

getMarker in interface P2DMarkerGroupInterface

Returns:

The marker flag.

setValid

public void setValid(boolean flag)

Set the group valid flag.

Parameters:

flag - if false the value will be invalid.

getRange

public P2DRange1DInterface getRange()

Returns the effective range of the marker.

Specified by:

getRange in interface P2DMarkerGroupInterface

Specified by:

getRange in interface P2DRangeInterface

Returns:

A range object.

setRange

public void setRange(P2DRange1DInterface range)

Set the range.

Specified by:

setRange in interface P2DMarkerGroupInterface

Specified by:

setRange in interface P2DRangeInterface

Parameters:

Range1D - The new axis range.

setRange

public void setRange(double lower,
            double upper)

Set the range.

Specified by:

setRange in interface P2DMarkerGroupInterface

Parameters:

lower - The lower limit.

upper - The upper limit.

findMarkerGroup

public P2DMarkerGroupInterface findMarkerGroup(double value,
                                      java.lang.String bColumn,
                                      double tolerance)

Find a marker with the given tolerance. The tolerance will be subtracted from the lower value and added to the higher value.

Specified by:

findMarkerGroup in interface P2DMarkerGroupInterface

Parameters:

value - The value that should be contained by the marker.

bColumn - The name of the bound column.

tolerance - The tolerance value.

Returns:

The first found marker group.

getUnit

public java.lang.String getUnit()

Get unit string.

Specified by:

getUnit in interface P2DMarkerGroupInterface

Returns:

the unit string of the marker. If there is no unit defined the method should return a 0-length string.

setColor

public void setColor(java.awt.Color c)

Set the color of the marker.

Specified by:

setColor in interface P2DMarkerGroupInterface

Parameters:

c - The new color.

getColor

public java.awt.Color getColor()

Get the current color of the marker.

Specified by:

getColor in interface P2DMarkerGroupInterface

Returns:

the color.

getCommands

public FwkCommandInterface[] getCommands()

Get commands.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class FwkPersistence

Returns:

a array containing the commands.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent ev)

Revoked when a property changed.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

ev - the property change event.

setBoundColumn

public void setBoundColumn(java.lang.String columnName)

Bind the marker to a specific column.

Specified by:

setBoundColumn in interface P2DMarkerGroupInterface

Parameters:

column - The name of the column to that the marker should be bound.

getBoundColumn

public java.lang.String getBoundColumn()

Get the name of the bounded column.

Specified by:

getBoundColumn in interface P2DMarkerGroupInterface

Returns:

the name of the bound column.