de.tif.jacob.core.data
Interface IDataBrowser

All Superinterfaces:

IDataRecordSet

public interface IDataBrowser
extends IDataRecordSet

A data browser represents a record set containing data browser records, i.e. instances of IDataBrowserRecord. The structure of each record contained is determined by the IBrowserDefinition the data browser is based on.

A data browser instance could be obtained by means of

IDataAccessor.getBrowser(IBrowserDefinition),

IDataAccessor.getBrowser(String),

IDataAccessor.createBrowser(IAdhocBrowserDefinition).

Field Summary

Fields inherited from interface de.tif.jacob.core.data.IDataRecordSet

UNLIMITED_RECORDS

Method Summary

void	clearSelections() Clears all record selections.
Filldirection	getFillDirection() Returns the fill direction of the last search operation.
java.lang.String	getName() Returns the name of this data browser, which equals to the name of the underlying IBrowserDefinition.
IDataBrowserRecord	getRecord(int index) Returns the data browser record given by its index.
IRelationSet	getRelationSet() Returns the relation set of the last search operation.
int	getSelectedRecordIndex() Returns the index of the selected record
void	propagateSelections() Propagates the selections for the browser specified.
void	search(IRelationSet relationSet) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing.
void	search(IRelationSet relationSet, Filldirection filldirection) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing.
void	search(java.lang.String relationSetName) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing.
void	search(java.lang.String relationSetName, Filldirection filldirection) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing.
void	searchWhere(IRelationSet relationSet, Filldirection filldirection, java.lang.String whereClause) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing and the given where clause.
void	searchWhere(IRelationSet relationSet, java.lang.String whereClause) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing and the given where clause.
void	searchWhere(java.lang.String relationSetName, Filldirection filldirection, java.lang.String whereClause) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing and the given where clause.
void	searchWhere(java.lang.String relationSetName, java.lang.String whereClause) Populates the data browser by means of performing a search operation, which will be constrained by QBE constraints of related data tables determined by the given relation set and the conditions of the related table aliases, if existing and the given where clause.
void	setSelectedRecordIndex(int index) Selects the record specified by the given record index.

Methods inherited from interface de.tif.jacob.core.data.IDataRecordSet

clear, getAccessor, getMaxRecords, getTableAlias, hasMoreRecords, recordCount, setMaxRecords

Method Detail

getName

java.lang.String getName()

Returns the name of this data browser, which equals to the name of the underlying IBrowserDefinition.

Specified by:

getName in interface IDataRecordSet

Returns:

the data browser name

getSelectedRecordIndex

int getSelectedRecordIndex()

Returns the index of the selected record

Returns:

The index of the selected record or -1, if no record is selected.

setSelectedRecordIndex

void setSelectedRecordIndex(int index)
                            throws java.lang.IndexOutOfBoundsException

Selects the record specified by the given record index.

After this method has been called, the given record index would be returned by getSelectedRecordIndex().

Parameters:

index - the index of the record to select.

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= index < IDataRecordSet.recordCount() is not fulfilled

clearSelections

void clearSelections()

Clears all record selections.

getRecord

IDataBrowserRecord getRecord(int index)
                             throws java.lang.IndexOutOfBoundsException

Returns the data browser record given by its index.

Parameters:

index - the index of the record to get.

Returns:

the desired record

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= index < IDataRecordSet.recordCount() is not fulfilled

propagateSelections

void propagateSelections()
                         throws RecordNotFoundException,
                                java.lang.RuntimeException

Propagates the selections for the browser specified.

When a selection is propagated, then all data tables related to this data browser are filled. Related data tables are determined by the relation set and the fill direction used in the last search operation.

Note that propagation may be an expensive operation, i.e. causing many data source accesses.

Throws:

RecordNotFoundException - if any data table record could not be retrieved from a data source

java.lang.RuntimeException - if no selections to propagate exist or any further error occurs during propagation

search

void search(java.lang.String relationSetName)
            throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to search(IRelationSet, Filldirection) except that the relation set is specified by name and Filldirection.BACKWARD is used by default.

Parameters:

relationSetName - the name of the relation set

Throws:

InvalidExpressionException - if any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

search

void search(IRelationSet relationSet)
            throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to search(IRelationSet, Filldirection) except that Filldirection.BACKWARD is used by default.

Parameters:

relationSet - the relation set

Throws:

InvalidExpressionException - if any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

search

void search(java.lang.String relationSetName,
            Filldirection filldirection)
            throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to search(IRelationSet, Filldirection) except that the relation set is specified by name.

Parameters:

relationSetName - the name of relation set

filldirection - the fill direction to use for subsequent calls of propagateSelections().

Throws:

InvalidExpressionException - if any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

search

void search(IRelationSet relationSet,
            Filldirection filldirection)
            throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

Parameters:

relationSet - the relation set

filldirection - the fill direction to use for subsequent calls of propagateSelections().

Throws:

InvalidExpressionException - if any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

searchWhere

void searchWhere(java.lang.String relationSetName,
                 java.lang.String whereClause)
                 throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing and

the given where clause.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to searchWhere(IRelationSet, Filldirection, String) except that the relation set is specified by name and Filldirection.BACKWARD is used by default.

Parameters:

relationSetName - the name of the relation set

whereClause - the SQL-like where clause, e.g. "employee.avail = 1 OR employee.ownerrole = 1"

Throws:

InvalidExpressionException - if the where clause or any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

searchWhere

void searchWhere(IRelationSet relationSet,
                 Filldirection filldirection,
                 java.lang.String whereClause)
                 throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing and

the given where clause.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

Parameters:

relationSet - the name of the relation set

filldirection - the fill direction to use for subsequent calls of propagateSelections().

whereClause - the SQL-like where clause, e.g. "employee.avail = 1 OR employee.ownerrole = 1"

Throws:

InvalidExpressionException - if the where clause or any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

searchWhere

void searchWhere(IRelationSet relationSet,
                 java.lang.String whereClause)
                 throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing and

the given where clause.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to searchWhere(IRelationSet, Filldirection, String) except that Filldirection.BACKWARD is used by default.

Parameters:

relationSet - the relation set

whereClause - the SQL-like where clause, e.g. "employee.avail = 1 OR employee.ownerrole = 1"

Throws:

InvalidExpressionException - if the where clause or any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

searchWhere

void searchWhere(java.lang.String relationSetName,
                 Filldirection filldirection,
                 java.lang.String whereClause)
                 throws InvalidExpressionException

Populates the data browser by means of performing a search operation, which will be constrained by

QBE constraints of related data tables determined by the given relation set and

the conditions of the related table aliases, if existing and

the given where clause.

Note that the number of records retrieved from data source is limited to the current maximum record setting.

This method is equivalent to searchWhere(IRelationSet, Filldirection, String) except that the relation set is specified by name.

Parameters:

relationSetName - the name of the relation set

filldirection - the fill direction to use for subsequent calls of propagateSelections().

whereClause - the SQL-like where clause, e.g. "employee.avail = 1 OR employee.ownerrole = 1"

Throws:

InvalidExpressionException - if the where clause or any given QBE constraint contains an invalid expression

See Also:

IDataRecordSet.getMaxRecords(), IDataRecordSet.setMaxRecords(int)

getRelationSet

IRelationSet getRelationSet()

Returns the relation set of the last search operation.

Returns:

the relation set or null if no search has been performed after last clear action.

getFillDirection

Filldirection getFillDirection()

Returns the fill direction of the last search operation.

Returns:

the fill direction or null if no search has been performed after last clear action.