com.highqsoft.odsx.hql

Class OdsxResultSet

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.odsx.hql.OdsxResultSet

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkItemInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, OdsxResultSetInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.infobus.DataItem

public class OdsxResultSet
extends FwkItem
implements OdsxResultSetInterface

The ODS Result set.

Author:

Andreas Hofmann $Revision: 1.20 $ $Date: 2017/04/06 13:29:54 $

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OdsxResultSet.ByteComparator
protected static class	OdsxResultSet.DateComparator
protected static class	OdsxResultSet.DoubleComparator
protected static class	OdsxResultSet.FloatComparator
protected static class	OdsxResultSet.IntComparator
protected static class	OdsxResultSet.LongLongComparator
protected static class	OdsxResultSet.ShortComparator
protected static class	OdsxResultSet.StringComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	charWidth The char width of the columns
protected CommandInterface	command The command that created the result set.
protected java.lang.String	dateOutputFormat The date output format string.
protected ElemResultSet[]	elemRes The ODS result set.
protected java.util.Locale	locale The locale
protected int	refCount A reference counter.
protected int[]	sortIdx The sort index.
protected java.lang.Object[]	stringVal The column string presentation.
static java.lang.String	version

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.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
OdsxResultSet(java.lang.String name, CommandInterface command) The construtor receiving the ods result set.
OdsxResultSet(java.lang.String name, CommandInterface command, ElemResultSet[] res) The construtor receiving the ods result set.
OdsxResultSet(java.lang.String name, CommandInterface command, java.lang.String[] res) The construtor receiving the ods result set.
OdsxResultSet(java.lang.String name, CommandInterface command, java.util.Vector res) The construtor receiving the ods result set.

Method Summary

Methods

Modifier and Type	Method and Description
void	attach() Increase the reference counter.
CommandInterface	createdBy() Return the command that created the result.
int	findColumn(java.lang.String name) Find a specific column.
java.lang.Object[]	getAttributeValues(int column) Get the attribute values.
java.lang.String	getCellStringValue(int column, int row) Get the cell string value.
int	getColumnCount() Get the column count.
int	getColumnDisplaySize(int column) Indicates the designated column's normal maximum width in characters.
java.lang.String[]	getColumnStringValue(int column) Get the column string value.
ElemResultSet[]	getElemResultSet() Get the ODS Result set of a ODS query
ResultColumnInterface[]	getResultColumns() Get the result columns.
int	getRowCount() Get the row count.
java.lang.String[]	getRowStringValue(int row) Get the row string value.
java.lang.String	getVersion() Return the version string of the FWK component.
java.lang.String[]	listColumns(java.lang.String pattern) List attribute names belong to the result set.
void	release() Release the object.
void	setDateFormatString(java.lang.String formatString) Set the Date format string.
void	setLocale(java.util.Locale locale) Set the locale of for this resultset.
void	sort(int colIdx, boolean asc) Order the rows by a special column.
void	sort(java.lang.String name, boolean asc) Order the rows by a special column.

Methods inherited from class com.highqsoft.fwk.FwkItem

addDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getProperty, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setName, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, 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 javax.infobus.DataItem

getSource

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

dateOutputFormat

protected java.lang.String dateOutputFormat

The date output format string.

elemRes

protected ElemResultSet[] elemRes

The ODS result set.

See Also:

ElemResultSet

charWidth

protected int[] charWidth

The char width of the columns

stringVal

protected java.lang.Object[] stringVal

The column string presentation.

command

protected CommandInterface command

The command that created the result set.

refCount

protected int refCount

A reference counter.

locale

protected java.util.Locale locale

The locale

sortIdx

protected int[] sortIdx

The sort index.

Constructor Detail

OdsxResultSet

public OdsxResultSet(java.lang.String name,
             CommandInterface command)

The construtor receiving the ods result set.

Parameters:

name - the result name.

command - The command that created the result.

OdsxResultSet

public OdsxResultSet(java.lang.String name,
             CommandInterface command,
             ElemResultSet[] res)

The construtor receiving the ods result set.

Parameters:

name - the result name.

command - The command that created the result.

res - The ods result set structure.

See Also:

ElemResultSet

OdsxResultSet

public OdsxResultSet(java.lang.String name,
             CommandInterface command,
             java.lang.String[] res)

The construtor receiving the ods result set.

Parameters:

name - the result name.

command - The command that created the result.

res - A string array result.

OdsxResultSet

public OdsxResultSet(java.lang.String name,
             CommandInterface command,
             java.util.Vector res)

The construtor receiving the ods result set.

Parameters:

name - the result name.

command - The command that created the result.

res - A vector containing the results.

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 FwkItem

setDateFormatString

public void setDateFormatString(java.lang.String formatString)

Set the Date format string. This method fires a property change event on property "DateFormatString".

Specified by:

setDateFormatString in interface FwkDescriptionInterface

Overrides:

setDateFormatString in class FwkPersistence

Parameters:

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, FwkPersistence.getCreationDate()

createdBy

public CommandInterface createdBy()

Return the command that created the result.

Specified by:

createdBy in interface OdsxResultSetInterface

Returns:

the command

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

Specified by:

release in interface javax.infobus.DataItem

Overrides:

release in class FwkItem

attach

public void attach()

Increase the reference counter.

Specified by:

attach in interface OdsxResultSetInterface

listColumns

public java.lang.String[] listColumns(java.lang.String pattern)

List attribute names belong to the result set.

Specified by:

listColumns in interface OdsxResultSetInterface

Parameters:

pattern - The pattern that must fulfill by the returned names.

Returns:

The array containing the matched column names.

findColumn

public int findColumn(java.lang.String name)

Find a specific column.

Specified by:

findColumn in interface OdsxResultSetInterface

Parameters:

name - the name of the column.

Returns:

the index of the column. The method returns -1 if no column was found.

sort

public void sort(int colIdx,
        boolean asc)

Order the rows by a special column.

Specified by:

sort in interface OdsxResultSetInterface

Parameters:

colidx - Column index to be the creteria. if the column doesn't exist for the given index, the sorting will be reseted.

asc - if true the order is ascending.

sort

public void sort(java.lang.String name,
        boolean asc)

Order the rows by a special column.

Specified by:

sort in interface OdsxResultSetInterface

Parameters:

name - Column name to be the creteria.

asc - if true the order is ascending.

getColumnDisplaySize

public int getColumnDisplaySize(int column)

Indicates the designated column's normal maximum width in characters.

Specified by:

getColumnDisplaySize in interface OdsxResultSetInterface

Parameters:

column - The column index.

Returns:

the width in characters of 0 if column doesn't exist.

getRowStringValue

public java.lang.String[] getRowStringValue(int row)

Get the row string value.

Specified by:

getRowStringValue in interface OdsxResultSetInterface

Parameters:

row - The row index.

Returns:

the string array containing the row string presentation.

getCellStringValue

public java.lang.String getCellStringValue(int column,
                                  int row)

Get the cell string value.

Specified by:

getCellStringValue in interface OdsxResultSetInterface

Parameters:

column - The column index.

row - The row index.

Returns:

the string containing the cell string presentation.

getColumnStringValue

public java.lang.String[] getColumnStringValue(int column)

Get the column string value.

Specified by:

getColumnStringValue in interface OdsxResultSetInterface

Parameters:

column - The column index.

Returns:

the string array containing the column string presentation.

getAttributeValues

public java.lang.Object[] getAttributeValues(int column)

Get the attribute values.

Parameters:

column - The column index.

Returns:

the attribute values. The return value is castable to NameValueSeqUnitId[]

getColumnCount

public int getColumnCount()

Get the column count.

Specified by:

getColumnCount in interface OdsxResultSetInterface

Returns:

the total number of available columns.

getRowCount

public int getRowCount()

Get the row count.

Specified by:

getRowCount in interface OdsxResultSetInterface

Returns:

the total number of available rowsa.

getResultColumns

public ResultColumnInterface[] getResultColumns()

Get the result columns.

Specified by:

getResultColumns in interface OdsxResultSetInterface

Returns:

the result columns.

getElemResultSet

public ElemResultSet[] getElemResultSet()

Get the ODS Result set of a ODS query

Specified by:

getElemResultSet in interface OdsxResultSetInterface

Returns:

the ODS result set.

See Also:

ElemResultSet

setLocale

public void setLocale(java.util.Locale locale)

Set the locale of for this resultset.

Specified by:

setLocale in interface OdsxResultSetInterface

Parameters:

locale - the Locale object.