com.highqsoft.interfaces.p2d

Interface P2DMarkerGroupInterface

All Superinterfaces:

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

All Known Implementing Classes:

P2DMarkerGroup

public interface P2DMarkerGroupInterface
extends FwkInfoBusMemberInterface, FwkPropertyChangeListenerInterface, FwkInfoBusImmediateAccessInterface, P2DRangeInterface

The P2DMarkerGroupInterface describes the functionality of a marker in the P2D package.

Since:

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

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER The upper marker sign.
static int	LOWER The lower marker sign.
static int	UPPER The upper marker sign.

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

Method Summary

Methods

Modifier and Type	Method and Description
P2DMarkerGroupInterface	findMarkerGroup(double value, java.lang.String boundColumn, double tolerance) Find a marker with the given tolerance.
java.lang.String	getBoundColumn() Get the name of the bounded column.
java.awt.Color	getColor() Get the current color of the marker.
long	getLowerIndex() Returns the lower value index of the marker.
long	getLowerIndex(java.lang.String colName) Returns the lower value index of the marker.
int	getMarker() get the marker falg.
P2DRange1DInterface	getRange() Returns the effective range of the marker.
long[]	getRangeIndex() Returns the upper value index 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.
boolean	hasValidValues() Returns a boolean that indicates whether the group has valid values.
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 channelName) Bind the marker to a specific column.
void	setColor(java.awt.Color c) Set the color 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	unregister() Unregister the marker group from producer.

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, getCommands, 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

getVersion, 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 java.beans.PropertyChangeListener

propertyChange

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

getName, isGroup, setProperty, setValidValues

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

addChild, addChildListener, containsChild, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString, getValueAsObject, getValueAsString, setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Methods inherited from interface com.highqsoft.interfaces.p2d.P2DRangeInterface

getLowerLimit, getUpperLimit, setLowerLimit, setUpperLimit

Field Detail

LOWER

static final int LOWER

The lower marker sign.

See Also:

Constant Field Values

CENTER

static final int CENTER

The upper marker sign.

See Also:

Constant Field Values

UPPER

static final int UPPER

The upper marker sign.

See Also:

Constant Field Values

Method Detail

unregister

void unregister()

Unregister the marker group from producer.

hasValidValues

boolean hasValidValues()

Returns a boolean that indicates whether the group has valid values.

Specified by:

hasValidValues in interface FwkInfoBusImmediateAccessInterface

Returns:

true if the group has valid values.

getLowerIndex

long getLowerIndex()

Returns the lower value index of the marker.

Returns:

the lower value index.

getUpperIndex

long getUpperIndex()

Returns the upper value index of the marker.

Returns:

the upper value index.

getLowerIndex

long getLowerIndex(java.lang.String colName)

Returns the lower value index of the marker.

Parameters:

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

Returns:

the lower value index.

getUpperIndex

long getUpperIndex(java.lang.String colName)

Returns the upper value index of the marker.

Parameters:

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

Returns:

the upper value index.

getRangeIndex

long[] getRangeIndex()

Returns the upper value index of the marker.

Returns:

the upper value index.

getRangeIndex

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

Returns the upper value index of the marker.

Parameters:

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

Returns:

the upper value index.

getUnit

java.lang.String getUnit()

Get unit string.

Returns:

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

setArea

void setArea(double lower,
           double upper)

Set the area of the marker.

Parameters:

lower - the lower coordinate of the marker.

upper - the upper coordinate of the marker.

set

void set(double value)

Sets the value that is marked.

Parameters:

value. -

setMarker

void setMarker(int marker)

Set the marker.

Parameters:

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

getMarker

int getMarker()

get the marker falg.

Returns:

The marker flag.

getRange

P2DRange1DInterface getRange()

Returns the effective range of the marker.

Specified by:

getRange in interface P2DRangeInterface

Returns:

A range object.

setRange

void setRange(P2DRange1DInterface range)

Set the range.

Specified by:

setRange in interface P2DRangeInterface

Parameters:

Range1D - The new axis range.

setRange

void setRange(double lower,
            double upper)

Set the range.

Parameters:

lower - The lower limit.

upper - The upper limit.

findMarkerGroup

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

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

Parameters:

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

boundColumn - The name of the bound column.

tolerance - The tolerance value.

Returns:

The first found marker group.

setColor

void setColor(java.awt.Color c)

Set the color of the marker.

Parameters:

c - The new color.

getColor

java.awt.Color getColor()

Get the current color of the marker.

Returns:

the color.

setBoundColumn

void setBoundColumn(java.lang.String channelName)

Bind the marker to a specific column.

Parameters:

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

getBoundColumn

java.lang.String getBoundColumn()

Get the name of the bounded column.

Returns:

the name of the bound column.