com.highqsoft.odsx.hql

Interface OdsxResultSetInterface

All Superinterfaces:

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

All Known Implementing Classes:

OdsxResultSet

public interface OdsxResultSetInterface
extends FwkItemInterface, javax.infobus.DataItem

The ODS Result set interface.

Author:

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

Field Summary

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
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.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[]	listColumns(java.lang.String pattern) List attribute names belong to the result set.
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 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

Method Detail

attach

void attach()

Increase the reference counter.

listColumns

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

List attribute names belong to the result set.

Parameters:

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

Returns:

The array containing the matched column names.

findColumn

int findColumn(java.lang.String name)

Find a specific column.

Parameters:

name - the name of the column.

Returns:

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

getColumnDisplaySize

int getColumnDisplaySize(int column)

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

Parameters:

column - The column index.

Returns:

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

getColumnStringValue

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

Get the column string value.

Parameters:

column - The column index.

Returns:

the string array containing the column string presentation.

getRowStringValue

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

Get the row string value.

Parameters:

row - The row index.

Returns:

the string array containing the row string presentation.

getCellStringValue

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

Get the cell string value.

Parameters:

column - The column index.

row - The row index.

Returns:

the string containing the cell string presentation.

getColumnCount

int getColumnCount()

Get the column count.

Returns:

the total number of available columns.

getRowCount

int getRowCount()

Get the row count.

Returns:

the total number of available rowsa.

getResultColumns

ResultColumnInterface[] getResultColumns()

Get the result columns.

Returns:

the result columns.

createdBy

CommandInterface createdBy()

Return the command that created the result.

Returns:

the command

getElemResultSet

ElemResultSet[] getElemResultSet()

Get the ODS Result set of a ODS query

Returns:

the ODS result set.

See Also:

ElemResultSet

setLocale

void setLocale(java.util.Locale locale)

Set the locale of for this resultset.

Parameters:

locale - the Locale object.

sort

void sort(int colIdx,
        boolean asc)

Order the rows by a special column.

Parameters:

colidx - Column index to be the creteria.

asc - if true the order is ascending.

sort

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

Order the rows by a special column.

Parameters:

name - Column name to be the creteria.

asc - if true the order is ascending.