com.highqsoft.fwk

Class FwkColumnAccess

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.FwkInfoBusImmediateAccess

com.highqsoft.fwk.FwkInfoBusDataAccess

com.highqsoft.fwk.FwkColumnAccess

All Implemented Interfaces:

FwkColumnAccessInterface, FwkColumnDataObserverInterface, FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInfoBusDataAccessInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.infobus.ArrayAccess, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, javax.infobus.ImmediateAccess

Direct Known Subclasses:

FwkColumnAccessGroup, FwkColumnAccessProducer.DropColumnAccess, FwkColumnAccessProducer.TestDataItem, LMSAscii.LMSAsciiColumn, OdsxColumnAccess, OdsxPresentableElement, RpcIIIColumnAccess, RpcIIIColumnProducer.TimeColumn

public class FwkColumnAccess
extends FwkInfoBusDataAccess
implements FwkColumnAccessInterface

FwkColumnAccess is the default implementation of the FwkColumnAccessInterface.

Property Keyword	Datatype	Default	Description
FwkColumnAccessInterface.ConsiderFlags	boolean	false	This flag is used to control whether the column consider the flag value.

Since:

$Date: 2017/04/06 13:28:57 $

Version:

$Revision: 1.21 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FwkColumnAccess.FwkSubColumnAccess

Nested classes/interfaces inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

FwkInfoBusImmediateAccess.ElementConsumer

Field Summary

Fields

Modifier and Type	Field and Description
protected double	average
protected boolean	averageIsValid
protected java.lang.String	columnName
static boolean	CONSIDER_FLAGS The flags that decides whether the flags should be considered.
static java.lang.String[]	DESCRIPTION_COLUMN_NAME The description column header names.
protected static FwkIconInterface	icon
protected double	lower
protected double	minPositiveValue
protected FwkColumnDataObserverInterface	observer
protected javax.infobus.InfoBusDataProducer	producer
protected java.lang.Object	range_lock
protected boolean	rangeIsValid
protected java.lang.String	shortName
protected double	standardDeviation
protected boolean	standardDeviationIsValid
protected java.lang.String	unit
protected double	upper
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

children, properties, valid

Fields inherited from class com.highqsoft.fwk.FwkItem

changeManager, 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, iconCount, iconKey, internetAddress, name, titleName

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

DATAARRAY_KEY, DEFINED_BIT, INVALID, NOT_MODIFIED_BIT, VALID, VALID_BIT, VISIBLE_BIT

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

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

INFOBUS_SOURCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FwkColumnAccess() A private default constructor.
	FwkColumnAccess(java.lang.String name, java.lang.String columnName, java.lang.String unit, FwkColumnDataObserverInterface observer) The constructor receiving the value matrix and its name.
	FwkColumnAccess(java.lang.String name, java.lang.String columnName, java.lang.String unit, short[] flags, double[] values) The constructor receiving the value matrix and its name.

Method Summary

Methods

Modifier and Type	Method and Description
static FwkColumnAccessInterface	createEmptyColumn(java.lang.String name) Create an empty column.
java.lang.String[]	dependsOn() Retrieves a string array containing the dependant channels.
protected void	determineRange() Determine the lower and upper limits of the column.
double	getAverage() Returns the average of the column data.
short	getAverageFlag() Returns a boolean whether the average is a valid value.
java.lang.String	getColumnName() Get the name of the column without prefix that uniq the name.
FwkCommandInterface[]	getCommands(FwkControllerInterface controller) Get the commands of the column.
int	getCount() Get the length of the column data array.
int[]	getDimensions() Returns an array of integers which has the same number of elements as the number of dimensions in the ArrayAccess and where each integer value is the the number of elements in the respective ArrayAccess dimension.
short	getFlagAt(int index) Retrieves a value flag at a specific index.
short[]	getFlags() Retrieves the flags belongs to the column data.
long	getIndex(double value) Get the lower limit index relative to the given channel.
long[]	getIndexRange(double lower, double upper) Get the index range relative to the given channel.
java.lang.Object	getItemByCoordinates(int[] coord) Returns the DataItem corresponding to the given coordinates.
double	getMaximum() Returns the upper value of the column.
double	getMinimum() Returns the lower value of the column.
double	getMinPositiveValue() Get the lowest value that is greater than 0.
java.lang.Class	getNativeDatatype() Get the data type of inner values.
java.lang.Object	getNativeValues() Get the inner values.
java.lang.Object	getNativeValues(int lower, int upper) Get a range of the inner values.
java.lang.String	getPresentationString(java.util.Locale locale) Returns the string representation of the item.
java.lang.Object	getProperty(java.lang.String propertyName) Get Properties.
double[]	getScale() Get the scaling.
java.lang.String	getShortName() Get the short name of the column
double	getStandardDeviation() Returns the standard deviation of the column data.
short	getStandardDeviationFlag() Returns a boolean whether the standard deviation is a valid value.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor) Returns an object which represents the data to be transferred.
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors() Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
java.lang.String	getUnitString() Retrieves the unit of the column.
java.lang.Object	getValueAsObject() Retrieves the local column of the data item.
java.lang.String	getValueAsString() Get the values as string.
double	getValueAt(int index) Retrieves a value at a specific index.
double[]	getValues() Get the values of the column.
java.lang.String	getVersion() Return the version string of the FWK component.
FwkColumnAccessInterface[]	independentColumns() Returns an array of dataitems this dataitem depends on.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataFlavor) Returns whether or not the specified data flavor is supported for this object.
boolean	isImplicit() Return a boolean whether the column is an implict column.
boolean	isIndependent() Return whether the column is an independent column.
static void	main(java.lang.String[] args) The Main test body.
void	release() Release the column.
protected void	reshape(int[] coord) Reshape for the setter routine if necessary.
void	setColumnName(java.lang.String newColumnName) Set the columnName.
void	setFlagAt(int index, short flag) Set a flag
void	setFlags(short[] flags) Set the flags of the column
void	setIndependent(boolean flag) Set the independent flag of the column.
protected void	setItemByCoordinates(int[] coord, byte[] item) Set new data as byte.
protected void	setItemByCoordinates(int[] coord, char[] item) Set new data as char.
protected void	setItemByCoordinates(int[] coord, double[] item) Set new data as float.
protected void	setItemByCoordinates(int[] coord, float[] item) Set new data as float.
protected void	setItemByCoordinates(int[] coord, int[] item) Set new data as int.
protected void	setItemByCoordinates(int[] coord, long[] item) Set new data as long.
void	setItemByCoordinates(int[] coord, java.lang.Object item) Sets a new value for an item at the indicated coordinates in an ArrayAccess.
void	setName(java.lang.String newName) Set the name of the column.
void	setScale(double[] scale) Set the scaling.
void	setValue(java.lang.Object col) Set a new value.
void	setValueAt(int index, double value) Set a value
javax.infobus.ArrayAccess	subdivide(int[] start, int[] end) This method is currently not supported.
java.lang.String	toString() Retrieves the representation string.

Methods inherited from class com.highqsoft.fwk.FwkInfoBusImmediateAccess

addChild, addChildListener, containsChild, fireChildAdded, fireChildRemoved, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, hasValidValues, isGroup, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren, setProperty, setValidValues

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, 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, lostOwnership, setClassName, setCreationDate

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion

Methods inherited from class java.lang.Object

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

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

getName, hasValidValues, isGroup, setProperty, setValidValues

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

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

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.FwkInfoBusItemGroupInterface

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

Methods inherited from interface javax.infobus.DataItem

getSource

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

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

isChangeManagerSuspended, suspendChangeManager

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

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.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

Field Detail

CONSIDER_FLAGS

public static final boolean CONSIDER_FLAGS

The flags that decides whether the flags should be considered. It can be change by setting the ColumnAccessInterface.ConsiderFlags keyword to true.

DESCRIPTION_COLUMN_NAME

public static final java.lang.String[] DESCRIPTION_COLUMN_NAME

The description column header names.

version

public static final java.lang.String version

See Also:

Constant Field Values

columnName

protected java.lang.String columnName

rangeIsValid

protected boolean rangeIsValid

upper

protected double upper

lower

protected double lower

minPositiveValue

protected double minPositiveValue

average

protected double average

standardDeviation

protected double standardDeviation

averageIsValid

protected boolean averageIsValid

standardDeviationIsValid

protected boolean standardDeviationIsValid

unit

protected java.lang.String unit

producer

protected javax.infobus.InfoBusDataProducer producer

icon

protected static final FwkIconInterface icon

shortName

protected java.lang.String shortName

observer

protected FwkColumnDataObserverInterface observer

range_lock

protected java.lang.Object range_lock

Constructor Detail

FwkColumnAccess

protected FwkColumnAccess()

A private default constructor.

FwkColumnAccess

public FwkColumnAccess(java.lang.String name,
               java.lang.String columnName,
               java.lang.String unit,
               short[] flags,
               double[] values)

The constructor receiving the value matrix and its name.

Parameters:

name - The name of the column to be published.

columnName - The column name only. The name of the item may be longer.

unit - The unit of the column.

flags - The flags belongs to the values.

values - The values.

FwkColumnAccess

public FwkColumnAccess(java.lang.String name,
               java.lang.String columnName,
               java.lang.String unit,
               FwkColumnDataObserverInterface observer)

The constructor receiving the value matrix and its name.

Parameters:

name - The name of the column to be published.

columnName - The column name only. The name of the item may be longer.

unit - The unit of the column.

observer - The data observer.

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 FwkInfoBusDataAccess

release

public void release()

Release the column.

Specified by:

release in interface FwkColumnDataObserverInterface

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkItem

setScale

public void setScale(double[] scale)

Set the scaling. Up to three parameter are currently possible.
result = (scale[0]+scale[1]*value)*scale[2];

Specified by:

setScale in interface FwkColumnDataObserverInterface

Parameters:

scale - an double array containing the scaling.

getScale

public double[] getScale()

Get the scaling.

Specified by:

getScale in interface FwkColumnDataObserverInterface

Returns:

an double array containing the scaling.

getColumnName

public java.lang.String getColumnName()

Get the name of the column without prefix that uniq the name.

Specified by:

getColumnName in interface FwkColumnAccessInterface

Returns:

The column name.

setColumnName

public void setColumnName(java.lang.String newColumnName)

Set the columnName.

Specified by:

setColumnName in interface FwkColumnAccessInterface

Parameters:

newColumnName - the new column name.

setName

public void setName(java.lang.String newName)

Set the name of the column.

Specified by:

setName in interface FwkDescriptionInterface

Overrides:

setName in class FwkItem

Parameters:

the - new name of the column

See Also:

FwkPersistence.getName()

getShortName

public java.lang.String getShortName()

Get the short name of the column

Specified by:

getShortName in interface FwkColumnAccessInterface

Returns:

the short name of the column.

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get Properties. Additionally to the properties of the InfoBusItem properties there are the following keyword available:

• DataArray - returns the DataArray of the column (double[]).

Specified by:

getProperty in interface FwkItemInterface

Specified by:

getProperty in interface javax.infobus.DataItem

Overrides:

getProperty in class FwkInfoBusImmediateAccess

Parameters:

propertyName - The keyword of the property.

Returns:

The value of the property.

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.io.IOException,
                                        java.awt.datatransfer.UnsupportedFlavorException

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Overrides:

getTransferData in class FwkInfoBusImmediateAccess

Parameters:

flavor - the requested flavor for the data

Throws:

java.io.IOException - - if the data is no longer available in the requested flavor. UnsupportedFlavorException - if the requested data flavor is not supporte

java.awt.datatransfer.UnsupportedFlavorException

See Also:

java.awt.datatransfer.DataFlavor.getRepresentationClass()

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

Overrides:

getTransferDataFlavors in class FwkInfoBusImmediateAccess

Returns:

an array of data flavors in which this data can be transferred

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor dataFlavor)

Returns whether or not the specified data flavor is supported for this object.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

Overrides:

isDataFlavorSupported in class FwkInfoBusImmediateAccess

Parameters:

flavor - the requested flavor for the data

Returns:

boolean indicating wjether or not the data flavor is supported

getDimensions

public int[] getDimensions()

Returns an array of integers which has the same number of elements as the number of dimensions in the ArrayAccess and where each integer value is the the number of elements in the respective ArrayAccess dimension. For example, a return value of {5,6,7} indicates a 5 x 6 x 7 three-dimensional ArrayAccess.

Specified by:

getDimensions in interface javax.infobus.ArrayAccess

Overrides:

getDimensions in class FwkInfoBusDataAccess

Returns:

array of dimension sizes

setValueAt

public void setValueAt(int index,
              double value)

Set a value

Specified by:

setValueAt in interface FwkColumnAccessInterface

Specified by:

setValueAt in interface FwkColumnDataObserverInterface

Parameters:

index - the index of the value to changed.

value - the new value.

setItemByCoordinates

public void setItemByCoordinates(int[] coord,
                        java.lang.Object item)
                          throws javax.infobus.InvalidDataException,
                                 FwkException

Sets a new value for an item at the indicated coordinates in an ArrayAccess. Setting a data item via this method should not affect Iterators for other access interfaces on the object that implements ArrayAccess. Indexing in each dimension is zero-based; that is, coordinates[i] range from 0 to (getDimensions()[i] - 1 ), to agree with Java arrays. We recommend that all producers accept an ImmediateAccess, if present, as the source of a new value, but also allow for producers to accept other types of Objects that make sense for the application.

Specified by:

setItemByCoordinates in interface javax.infobus.ArrayAccess

Overrides:

setItemByCoordinates in class FwkInfoBusDataAccess

Parameters:

coordinates - the coordinates of the element to be set. It must have the length 2.

newValue - the new value of the element. Must be an instance of java.lang.Number[]

Throws:

javax.infobus.InvalidDataException - if changes are supported but newValue is not a legal value for the element

java.lang.UnsupportedOperationException - if changes are not supported

FwkException

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        double[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as float.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        float[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as float.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        long[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as long.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        int[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as int.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        char[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as char.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

setItemByCoordinates

protected void setItemByCoordinates(int[] coord,
                        byte[] item)
                             throws javax.infobus.InvalidDataException,
                                    FwkException

Set new data as byte.

Throws:

javax.infobus.InvalidDataException

FwkException

See Also:

setItemByCoordinates(int[], Object)

reshape

protected void reshape(int[] coord)

Reshape for the setter routine if necessary.

Parameters:

coord - The new coordinates.

subdivide

public javax.infobus.ArrayAccess subdivide(int[] start,
                                  int[] end)
                                    throws java.lang.UnsupportedOperationException

This method is currently not supported.

Specified by:

subdivide in interface javax.infobus.ArrayAccess

Overrides:

subdivide in class FwkInfoBusDataAccess

Parameters:

start - The starting coordinates.

end - The starting coordinates.

Returns:

The sub array.

Throws:

java.lang.UnsupportedOperationException

getItemByCoordinates

public java.lang.Object getItemByCoordinates(int[] coord)

Returns the DataItem corresponding to the given coordinates. Valid coordinates for dimension k are 0 to (getDimensions()[k] - 1).

Specified by:

getItemByCoordinates in interface javax.infobus.ArrayAccess

Overrides:

getItemByCoordinates in class FwkInfoBusDataAccess

Parameters:

coordinates - - the coordinates of the desired DataItem in array form

Returns:

the DataItem located at the given coordinates

Throws:

java.lang.ArrayIndexOutOfBoundsException - if any of coordinates[k] are less than 0 or greater than getDimensions()[k] - 1

getIndex

public long getIndex(double value)

Get the lower limit index relative to the given channel.

Specified by:

getIndex in interface FwkColumnAccessInterface

Parameters:

value - the physical value to be found as index.

Returns:

the index of the first occurance of the given value.

getIndexRange

public long[] getIndexRange(double lower,
                   double upper)

Get the index range relative to the given channel.

Specified by:

getIndexRange in interface FwkColumnAccessInterface

Parameters:

lower - The lower value to be found.

upper - The upper value to be found.

Returns:

the index range. If the given range was not found the a 0 length array will be returned.

getValueAsObject

public java.lang.Object getValueAsObject()

Retrieves the local column of the data item.

Specified by:

getValueAsObject in interface javax.infobus.ImmediateAccess

Overrides:

getValueAsObject in class FwkInfoBusImmediateAccess

Returns:

the ODS object LocalColumn

setValue

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

Set a new value.

Specified by:

setValue in interface javax.infobus.ImmediateAccess

Overrides:

setValue in class FwkInfoBusImmediateAccess

Parameters:

col - The new column value. It must be an instance of java.lang.Number[].

Throws:

javax.infobus.InvalidDataException

FwkException

toString

public java.lang.String toString()

Retrieves the representation string. Currently it returns the name.

Overrides:

toString in class FwkDescription

Parameters:

l - The Locale object or null.

Returns:

The presentation string.

getValueAsString

public java.lang.String getValueAsString()

Get the values as string. The column data values are returned in a single string separated by a TAB.

Specified by:

getValueAsString in interface javax.infobus.ImmediateAccess

Overrides:

getValueAsString in class FwkInfoBusImmediateAccess

Returns:

The string value.

getCount

public int getCount()

Get the length of the column data array.

Specified by:

getCount in interface FwkColumnAccessInterface

Specified by:

getCount in interface FwkColumnDataObserverInterface

Returns:

The total number of elements of the column.

See Also:

DataType

getValues

public double[] getValues()
                   throws FwkException

Get the values of the column.

Specified by:

getValues in interface FwkColumnAccessInterface

Returns:

An array containing the column data.

Throws:

FwkException

See Also:

#getFlag

getValueAt

public double getValueAt(int index)
                  throws FwkException

Retrieves a value at a specific index.

Specified by:

getValueAt in interface FwkColumnAccessInterface

Specified by:

getValueAt in interface FwkColumnDataObserverInterface

Parameters:

index - The index of interest.

Returns:

The value at the specified index.

Throws:

An - exception if the index is out of range.

FwkException

See Also:

FwkColumnAccessInterface.getFlagAt(int)

getFlags

public short[] getFlags()

Retrieves the flags belongs to the column data.

Specified by:

getFlags in interface FwkColumnAccessInterface

Returns:

An array that contains the flags for each column value.

See Also:

Odsx Upper documentation.

setFlagAt

public void setFlagAt(int index,
             short flag)

Set a flag

Specified by:

setFlagAt in interface FwkColumnAccessInterface

Specified by:

setFlagAt in interface FwkColumnDataObserverInterface

Parameters:

index - the index of the flag to changed.

flag - the new flag.

See Also:

FwkColumnAccessInterface

setFlags

public void setFlags(short[] flags)

Set the flags of the column

Specified by:

setFlags in interface FwkColumnAccessInterface

Parameters:

flags - The array containing the new flags.

getFlagAt

public short getFlagAt(int index)
                throws FwkException

Retrieves a value flag at a specific index.

Specified by:

getFlagAt in interface FwkColumnAccessInterface

Specified by:

getFlagAt in interface FwkColumnDataObserverInterface

Parameters:

index - The index of interest.

Returns:

The value flag at the specified index.

Throws:

An - exception if the index is out of range.

FwkException

See Also:

FwkColumnAccessInterface.getFlags(), FwkColumnAccessInterface.getFlagAt(int)

determineRange

protected void determineRange()

Determine the lower and upper limits of the column.

getMinimum

public double getMinimum()

Returns the lower value of the column.

Specified by:

getMinimum in interface FwkColumnAccessInterface

Returns:

The lowerest value of the column.

getMinPositiveValue

public double getMinPositiveValue()

Get the lowest value that is greater than 0. This method is needed for logarithmn use.

Specified by:

getMinPositiveValue in interface FwkColumnAccessInterface

Returns:

the lowest value that is greater than 0. If no value is greater than 0 the method returns Double.NaN.

getMaximum

public double getMaximum()

Returns the upper value of the column.

Specified by:

getMaximum in interface FwkColumnAccessInterface

Returns:

The highest value of the column.

getUnitString

public java.lang.String getUnitString()

Retrieves the unit of the column.

Specified by:

getUnitString in interface FwkColumnAccessInterface

Returns:

The unit string belongs to the column.

dependsOn

public java.lang.String[] dependsOn()

Retrieves a string array containing the dependant channels.

Specified by:

dependsOn in interface FwkColumnAccessInterface

Returns:

an array of dataitem names.

independentColumns

public FwkColumnAccessInterface[] independentColumns()

Returns an array of dataitems this dataitem depends on. If the function returns null the item depends on no item.

Specified by:

independentColumns in interface FwkColumnAccessInterface

Returns:

an array of dataitems.

isIndependent

public boolean isIndependent()

Return whether the column is an independent column.

Specified by:

isIndependent in interface FwkColumnAccessInterface

Returns:

true if the column is independent.

setIndependent

public void setIndependent(boolean flag)

Set the independent flag of the column.

Parameters:

flag - if true the column will be independent.

isImplicit

public boolean isImplicit()

Return a boolean whether the column is an implict column.

For more information abount implicit columns see org.asam.ods.Column

Specified by:

isImplicit in interface FwkColumnAccessInterface

Specified by:

isImplicit in interface FwkColumnDataObserverInterface

Returns:

true if the column is implicit.

getNativeDatatype

public java.lang.Class getNativeDatatype()

Get the data type of inner values.

Specified by:

getNativeDatatype in interface FwkColumnDataObserverInterface

Returns:

the class of the inner value

getNativeValues

public java.lang.Object getNativeValues(int lower,
                               int upper)

Get a range of the inner values.

Specified by:

getNativeValues in interface FwkColumnDataObserverInterface

Parameters:

lower - the lower index of the range of interest.

upper - the upper index of the range of interest.

Returns:

An array containing the inner values.

getNativeValues

public java.lang.Object getNativeValues()

Get the inner values.

Specified by:

getNativeValues in interface FwkColumnDataObserverInterface

Returns:

An array containing the inner values.

getAverage

public double getAverage()

Returns the average of the column data.

Specified by:

getAverage in interface FwkColumnAccessInterface

Returns:

the average

getStandardDeviation

public double getStandardDeviation()

Returns the standard deviation of the column data.

Specified by:

getStandardDeviation in interface FwkColumnAccessInterface

Returns:

the standard deviation

getAverageFlag

public short getAverageFlag()

Returns a boolean whether the average is a valid value.

Specified by:

getAverageFlag in interface FwkColumnAccessInterface

Returns:

true if the average is valid.

getStandardDeviationFlag

public short getStandardDeviationFlag()

Returns a boolean whether the standard deviation is a valid value.

Specified by:

getStandardDeviationFlag in interface FwkColumnAccessInterface

Returns:

true if the standard deviation is valid.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale locale)

Returns the string representation of the item.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Specified by:

getPresentationString in interface FwkPresentationInterface

Specified by:

getPresentationString in interface javax.infobus.ImmediateAccess

Overrides:

getPresentationString in class FwkDescription

Parameters:

locale - The Locale object or null.

Returns:

The localized presentation string.

getCommands

public FwkCommandInterface[] getCommands(FwkControllerInterface controller)

Get the commands of the column.

Specified by:

getCommands in interface FwkPersistenceInterface

Overrides:

getCommands in class FwkPersistence

Parameters:

controller - The Command controller.

Returns:

the command array of the column

createEmptyColumn

public static FwkColumnAccessInterface createEmptyColumn(java.lang.String name)

Create an empty column.

Parameters:

name - The name of the column.

Returns:

a column containing the value [0,1].

main

public static void main(java.lang.String[] args)

The Main test body.