com.highqsoft.interfaces.fwk

Interface FwkColumnAccessInterface

All Superinterfaces:

javax.infobus.ArrayAccess, java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, FwkColumnDataObserverInterface, FwkCompareInterface, FwkDescriptionInterface, FwkInfoBusDataAccessInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInterface, FwkTransferableInterface, javax.infobus.ImmediateAccess, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

OdsxColumnInterface

All Known Implementing Classes:

FwkColumnAccess, FwkColumnAccess.FwkSubColumnAccess, FwkColumnAccessGroup, FwkColumnAccessProducer.DropColumnAccess, FwkColumnAccessProducer.TestDataItem, LMSAscii.LMSAsciiColumn, OdsxApplicationElement, OdsxColumn, OdsxColumnAccess, OdsxColumnProducer.VMColumnGroup, OdsxInstanceElement, OdsxPresentableElement, OdsxRecursiveApplicationElement, OdsxSessionElement, RpcIIIColumnAccess, RpcIIIColumnProducer.ColumnGroup, RpcIIIColumnProducer.TimeColumn

public interface FwkColumnAccessInterface
extends FwkInfoBusDataAccessInterface, FwkColumnDataObserverInterface

The FwkColumnAccess interface provides identifying and descriptive information about column data item.

The property entry FwkColumnAccessInterface.ConsiderFlag decides whether the field CONSIDER_FLAGS is true or false. It is can be used by consumers to shorten the time of evaluation the flags.

Since:

$Date: 2017/04/06 13:29:09 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATAARRAY_KEY The property name to retrieve the data.
static short	DEFINED_BIT The DEFINED bit values.
static short	INVALID Invalid classifation flag.
static short	NOT_MODIFIED_BIT The NOT_MODIFIED bit values.
static short	VALID Valid classification flag.
static short	VALID_BIT The VALID bit values.
static short	VISIBLE_BIT The VISIBLE bit values.

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
java.lang.String[]	dependsOn() Returns an array of dataitem names this dataitem depends on.
double	getAverage() Returns the average of the column data.
short	getAverageFlag() Returns the flag of the average.
java.lang.String	getColumnName() Get the name of the column without prefix that makes the name unique on the infobus.
int	getCount() Returns the total number of values located inside the column.
short	getFlagAt(int index) Returns a flag of the local columbn at the specified position.
short[]	getFlags() Returns an array of bytes containing the flags for the value array.
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.
double	getMaximum() Returns the maximum value of the column.
double	getMinimum() Returns the mimimum value of the column.
double	getMinPositiveValue() Get the lowest value that is greater than 0.
java.lang.String	getShortName() Get the short name of the column
double	getStandardDeviation() Returns the standard deviation of the column data.
short	getStandardDeviationFlag() Returns the flag of the standard deviation.
java.lang.String	getUnitString() Returns the unit string of the local column.
double	getValueAt(int index) Returns a value of the local columbn at the specified position.
double[]	getValues() Returns an array containing the data.
FwkColumnAccessInterface[]	independentColumns() Returns an array of dataitems this dataitem depends on.
boolean	isImplicit() Return a boolean whether the column is an implict column.
boolean	isIndependent() Return a boolean whether the column is an independent column.
void	setColumnName(java.lang.String newColumnName) Set the columnName.
void	setFlagAt(int index, short flag) Set a flag of the column
void	setFlags(short[] flags) Set the flags of the column
void	setValueAt(int index, double value) Set a value of the column

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, 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 com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

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

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

Methods inherited from interface javax.infobus.DataItem

getProperty, getSource, release

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString, getValueAsObject, getValueAsString, setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Methods inherited from interface javax.infobus.ArrayAccess

getDimensions, getItemByCoordinates, setItemByCoordinates, subdivide

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

getNativeDatatype, getNativeValues, getNativeValues, getScale, isChangeManagerSuspended, release, setScale, suspendChangeManager

Field Detail

VALID

static final short VALID

Valid classification flag.

See Also:

Constant Field Values

INVALID

static final short INVALID

Invalid classifation flag.

See Also:

Constant Field Values

VALID_BIT

static final short VALID_BIT

The VALID bit values.

See Also:

Constant Field Values

VISIBLE_BIT

static final short VISIBLE_BIT

The VISIBLE bit values.

See Also:

Constant Field Values

NOT_MODIFIED_BIT

static final short NOT_MODIFIED_BIT

The NOT_MODIFIED bit values.

See Also:

Constant Field Values

DEFINED_BIT

static final short DEFINED_BIT

The DEFINED bit values.

See Also:

Constant Field Values

DATAARRAY_KEY

static final java.lang.String DATAARRAY_KEY

The property name to retrieve the data.

See Also:

Constant Field Values

Method Detail

getColumnName

java.lang.String getColumnName()

Get the name of the column without prefix that makes the name unique on the infobus.

Returns:

The column name.

setColumnName

void setColumnName(java.lang.String newColumnName)

Set the columnName.

Parameters:

newColumnName - the new column name.

getCount

int getCount()

Returns the total number of values located inside the column.

Specified by:

getCount in interface FwkColumnDataObserverInterface

Returns:

The total number of values.

See Also:

DataType

getValues

double[] getValues()

Returns an array containing the data.

Returns:

an array of type double.

See Also:

#getFlag

getFlags

short[] getFlags()

Returns an array of bytes containing the flags for the value array.
0x00 : valid
other : invalid

Returns:

an array of flags.

See Also:

getValue

getValueAt

double getValueAt(int index)
                  throws java.lang.RuntimeException

Returns a value of the local columbn at the specified position.

Specified by:

getValueAt in interface FwkColumnDataObserverInterface

Parameters:

index - The index of the value.

Returns:

The value of the local column at the requested position.

Throws:

java.lang.RuntimeException

See Also:

getFlagAt(int)

getFlagAt

short getFlagAt(int index)
                throws java.lang.RuntimeException

Returns a flag of the local columbn at the specified position.

Specified by:

getFlagAt in interface FwkColumnDataObserverInterface

Parameters:

index - The index of the flag.

Returns:

The flag of the local column at the requested position.

Throws:

java.lang.RuntimeException

See Also:

getFlags(), getFlagAt(int)

getMinimum

double getMinimum()

Returns the mimimum value of the column.

Returns:

The lowest value of the column.

getMinPositiveValue

double getMinPositiveValue()

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

Returns:

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

getMaximum

double getMaximum()

Returns the maximum value of the column.

Returns:

The highest value of the column.

getUnitString

java.lang.String getUnitString()

Returns the unit string of the local column. If the function returns null the item has not assigned any unit.

Returns:

the unit string.

dependsOn

java.lang.String[] dependsOn()

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

Returns:

an array of dataitem names.

independentColumns

FwkColumnAccessInterface[] independentColumns()

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

Returns:

an array of dataitems.

isIndependent

boolean isIndependent()

Return a boolean whether the column is an independent column.

Returns:

true if the column is independent.

isImplicit

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 FwkColumnDataObserverInterface

Returns:

true if the column is implicit.

getAverage

double getAverage()

Returns the average of the column data.

Returns:

the average

getStandardDeviation

double getStandardDeviation()

Returns the standard deviation of the column data.

Returns:

the standard deviation

getAverageFlag

short getAverageFlag()

Returns the flag of the average. It return the VALID or INVALID value.

Returns:

the flag.

getStandardDeviationFlag

short getStandardDeviationFlag()

Returns the flag of the standard deviation. It return the VALID or INVALID value.

Returns:

the flag.

getShortName

java.lang.String getShortName()

Get the short name of the column

getIndex

long getIndex(double value)

Get the lower limit index relative to the given channel.

Parameters:

value - the physical value to be found as index.

Returns:

the index of the first occurance of the given value.

getIndexRange

long[] getIndexRange(double lower,
                   double upper)

Get the index range relative to the given channel.

Parameters:

lower - The lower value to be found.

upper - The upper value to be found.

Returns:

the index range.

setFlags

void setFlags(short[] flags)

Set the flags of the column

Parameters:

flags - The array containing the new flags.

setFlagAt

void setFlagAt(int index,
             short flag)

Set a flag of the column

Specified by:

setFlagAt in interface FwkColumnDataObserverInterface

Parameters:

index - the index of the flag.

flag - The flag to be set.

See Also:

FwkColumnAccessInterface

setValueAt

void setValueAt(int index,
              double value)

Set a value of the column

Specified by:

setValueAt in interface FwkColumnDataObserverInterface

Parameters:

index - the index of the value.

value - The value to be set.