org.tentackle.swing.rdc

Class AbstractPdoSearch<T extends PersistentDomainObject<T>>

java.lang.Object

org.tentackle.swing.rdc.AbstractPdoSearch<T>

Type Parameters:

T - the pdo type

All Implemented Interfaces:

DomainContextProvider, PdoSearch<T>

Direct Known Subclasses:

DefaultSearch

public abstract class AbstractPdoSearch<T extends PersistentDomainObject<T>>
extends Object
implements PdoSearch<T>

Common base class for a PDO search.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
static int	defaultFetchSize the default fetchsize.
static int	defaultMaxRowCount the default max row count.
static int	defaultWarnRowCount the default warn row count.

Constructor Summary

Constructors

Constructor and Description
AbstractPdoSearch(Class<T> pdoClass, DomainContext context) Creates a PDO search. With defaultFetchSize, defaultWarnRowCount and defaultMaxRowCount.
AbstractPdoSearch(Class<T> pdoClass, DomainContext context, int fetchSize, int warnRowCount, int maxRowCount) Creates a PDO search.

Method Summary

Modifier and Type	Method and Description
T	createPdo() Creates a new PDO for this search.
void	execute(Consumer<List<T>> pdoDisplay) Executes the search.
abstract org.tentackle.misc.ScrollableResource<T>	findByCriteria(T proxy) Finds the PDOs by selection criteria.
DomainContext	getDomainContext()
String	getFormTableName() Overrides the FormTable preferences name.
Class<T>	getPdoClass() Gets the PDO class.
int	getPdoClassId() Gets the PDO class id.
boolean	isDialogNotShownIfSearchImmediateFindsSingleMatch() Dont show the dialog if exactly a single object is found. Makes only sense with isSearchImmediate().
boolean	isDialogShownIfSearchImmediateFails() Show dialog if searchImmediate fails.
boolean	isSearchImmediate() Start search immediately without asking the user to enter the search criteria.
boolean	isSearchPanelInvisible() Search criteria panel visibility.
boolean	isTableViewInitiallyShown() Initially show table-view instead of tree-view.
boolean	isViewModeFixed() Don't allow the user to change the view mode.
boolean	isViewRebuildNecessary() View should be rebuilt for each new display of search results.
void	setDialogNotShownIfSingleMatch(boolean dialogNotShownIfSingleMatch)
void	setDialogShownIfSearchImmediateFails(boolean dialogShownIfSearchImmediateFails)
void	setFormTableName(String formTableName)
void	setSearchImmediate(boolean searchImmediate)
void	setSearchPanelInvisible(boolean searchPanelInvisible)
void	setTableViewInitiallyShown(boolean tableViewInitiallyShown)
void	setViewModeFixed(boolean viewModeFixed)
void	setViewRebuildNecessary(boolean viewRebuildNecessary)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.swing.rdc.PdoSearch

getSearchCriteriaAsString, getSearchPanel, isResultValid, isSearchCriteriaValid, isSearchRetrievingAll, presetSearchCriteria, resetSearchCriteria

Methods inherited from interface org.tentackle.pdo.DomainContextProvider

on, op

Field Detail

defaultFetchSize

public static int defaultFetchSize

the default fetchsize.

defaultWarnRowCount

public static int defaultWarnRowCount

the default warn row count.

defaultMaxRowCount

public static int defaultMaxRowCount

the default max row count.

Constructor Detail

AbstractPdoSearch

public AbstractPdoSearch(Class<T> pdoClass,
                         DomainContext context,
                         int fetchSize,
                         int warnRowCount,
                         int maxRowCount)

Creates a PDO search.

Parameters:

pdoClass - the pdo class

context - the domain context

fetchSize - the fetchsize

warnRowCount - number of rows displayable without warning, 0 = unlimited

maxRowCount - maximum number of rows displayable, 0 = unlimited

AbstractPdoSearch

public AbstractPdoSearch(Class<T> pdoClass,
                         DomainContext context)

Creates a PDO search.
With defaultFetchSize, defaultWarnRowCount and defaultMaxRowCount.

Parameters:

pdoClass - the pdo class

context - the domain context

Method Detail

getPdoClassId

public int getPdoClassId()

Description copied from interface: PdoSearch

Gets the PDO class id.

Specified by:

getPdoClassId in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

the class id

getPdoClass

public Class<T> getPdoClass()

Description copied from interface: PdoSearch

Gets the PDO class.

Specified by:

getPdoClass in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

the pdo class

getDomainContext

public DomainContext getDomainContext()

Specified by:

getDomainContext in interface DomainContextProvider

createPdo

public T createPdo()

Description copied from interface: PdoSearch

Creates a new PDO for this search.

Specified by:

createPdo in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

the pdo

execute

public void execute(Consumer<List<T>> pdoDisplay)

Description copied from interface: PdoSearch

Executes the search.

Specified by:

execute in interface PdoSearch<T extends PersistentDomainObject<T>>

Parameters:

pdoDisplay - the display for the retrieved pdos

findByCriteria

public abstract org.tentackle.misc.ScrollableResource<T> findByCriteria(T proxy)

Finds the PDOs by selection criteria.

Parameters:

proxy - the pdo to invoke the method(s) on

Returns:

the cursor

isSearchImmediate

public boolean isSearchImmediate()

Description copied from interface: PdoSearch

Start search immediately without asking the user to enter the search criteria.

Specified by:

isSearchImmediate in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if search immediately

setSearchImmediate

public void setSearchImmediate(boolean searchImmediate)

isDialogNotShownIfSearchImmediateFindsSingleMatch

public boolean isDialogNotShownIfSearchImmediateFindsSingleMatch()

Description copied from interface: PdoSearch

Dont show the dialog if exactly a single object is found.
Makes only sense with isSearchImmediate().

Specified by:

isDialogNotShownIfSearchImmediateFindsSingleMatch in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if don't show dialog if exactly single item matches (default = false)

setDialogNotShownIfSingleMatch

public void setDialogNotShownIfSingleMatch(boolean dialogNotShownIfSingleMatch)

isSearchPanelInvisible

public boolean isSearchPanelInvisible()

Description copied from interface: PdoSearch

Search criteria panel visibility.

Specified by:

isSearchPanelInvisible in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if search panel should not be visible (makes only sense with isSearchImmediate() == true)

setSearchPanelInvisible

public void setSearchPanelInvisible(boolean searchPanelInvisible)

isDialogShownIfSearchImmediateFails

public boolean isDialogShownIfSearchImmediateFails()

Description copied from interface: PdoSearch

Show dialog if searchImmediate fails.

Specified by:

isDialogShownIfSearchImmediateFails in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if dialog is shown even if immediate search fails (makes only sense with isSearchImmediate() == true)

setDialogShownIfSearchImmediateFails

public void setDialogShownIfSearchImmediateFails(boolean dialogShownIfSearchImmediateFails)

isTableViewInitiallyShown

public boolean isTableViewInitiallyShown()

Description copied from interface: PdoSearch

Initially show table-view instead of tree-view.

Specified by:

isTableViewInitiallyShown in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if switch to table view initially

setTableViewInitiallyShown

public void setTableViewInitiallyShown(boolean tableViewInitiallyShown)

isViewModeFixed

public boolean isViewModeFixed()

Description copied from interface: PdoSearch

Don't allow the user to change the view mode.

Specified by:

isViewModeFixed in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if user cannot change between table and tree view

setViewModeFixed

public void setViewModeFixed(boolean viewModeFixed)

isViewRebuildNecessary

public boolean isViewRebuildNecessary()

Description copied from interface: PdoSearch

View should be rebuilt for each new display of search results.

Specified by:

isViewRebuildNecessary in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

true if rebuild the view

setViewRebuildNecessary

public void setViewRebuildNecessary(boolean viewRebuildNecessary)

getFormTableName

public String getFormTableName()

Description copied from interface: PdoSearch

Overrides the FormTable preferences name.

Specified by:

getFormTableName in interface PdoSearch<T extends PersistentDomainObject<T>>

Returns:

the preferences name, null if default

setFormTableName

public void setFormTableName(String formTableName)