org.scrashmeow.ojb.console.ui.control.grid.factory
Class SearchGridControlFactory

java.lang.Object
  |
  +--org.scrashmeow.ojb.console.ui.control.OjbcViewControlFactory
        |
        +--org.scrashmeow.ojb.console.ui.control.grid.factory.SearchGridControlFactory

All Implemented Interfaces:

ApplicationServiceAware, java.io.Serializable

Direct Known Subclasses:

IndexedSearchGridControlFactory

public class SearchGridControlFactory

extends OjbcViewControlFactory

Author:

alexander To change this generated comment edit the template variable "typecomment": Window>Preferences>Java>Templates. To enable and disable the creation of type comments go to Window>Preferences>Java>Code Generation.

See Also:

Serialized Form

Field Summary

protected org.apache.ojb.broker.metadata.ClassDescriptor	classDescriptor Field classDescriptor
protected java.lang.String	dispatchProperty Field dispatchProperty
protected java.lang.String	nullValue Field nullValue
protected java.lang.String	pagerFormName Field pagerFormName
protected java.lang.String	selectedformName Field selectedformName
protected java.lang.String	sizerFormName Field sizerFormName
protected boolean	sortAscending Field sortAscending
protected java.lang.String	sortAscendingName Field sortAscendingName
protected java.lang.String	sortColumn Field sortColumn
protected java.lang.String	sortColumnName Field sortColumnName

Constructor Summary

SearchGridControlFactory()
Constructor for GridControlFactory.

Method Summary

protected int	calcStartIndex(int currentWindow, int windowSize) Method calcStartIndex @add-javadoc!!!
protected long	calcWindowCount(int queryResultSize, int windowSize) Method calcWindowCount @add-javadoc!!!
GridActionBar	createActionBar(int objectCount) Method createActionBar @add-javadoc!!!
GridControl	createGrid(java.util.Iterator queryResults, int queryResultSize, int windowSize, int currentWindow) Creates a grid control of data.
GridControl	createGridControl() Method createGridControl @add-javadoc!!!
java.util.List	createGridHeaders() Method buildGridHeaders.
java.util.List	createGridRows(java.util.Collection gridData, int currentWindow, int windowSize) Method createGridRows @add-javadoc!!!
java.lang.String	createGridRowUid(org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.Object inst, int index) Method createGridRowUid @add-javadoc!!!
GridDataLink	createHeaderItem() Method createHeaderItem @add-javadoc!!!
GridPager	createPager(int currentWindow, int windowCount) Method createPager @add-javadoc!!!
GridWindowSizer	createWindowSizer() Method createWindowSizer @add-javadoc!!!
protected boolean[]	determineFieldsToDisplayFlags(org.apache.ojb.broker.metadata.ClassDescriptor cld) Method determineFieldsToDisplayFlags @add-javadoc!!!
java.lang.String	getBrowseableValue(java.lang.Object value)
org.apache.ojb.broker.metadata.ClassDescriptor	getClassDescriptor() Returns the classDescriptor.
java.lang.String	getDispatchProperty() Returns the dispatchProperty.
java.lang.String	getNullValue() Returns the nullValue.
java.lang.String	getPagerFormName() Returns the pagerFormName.
java.lang.String	getSelectedformName() Returns the selectedformName.
java.lang.String	getSizerFormName() Returns the sizerFormName.
boolean	getSortAscending() Returns the sortAscending.
java.lang.String	getSortAscendingName() Returns the sortAscendingName.
java.lang.String	getSortColumn() Returns the sortColumn.
java.lang.String	getSortColumnName() Returns the sortColumnName.
static SearchGridControlFactory	newInstance(ApplicationService service, HttpServletRequest request, org.apache.ojb.broker.metadata.ClassDescriptor cld, java.lang.String selectedFormName, java.lang.String pagerFormName, java.lang.String sizerFormName, java.lang.String dispatchProperty, java.lang.String sortColumn, java.lang.String sortColumnName, boolean sortAscending, java.lang.String sortAscendingName) Method newInstance @add-javadoc!!!
protected int	normalizeCurrentWindow(int currentWindow, int windowCount) Method normalizeCurrentWindow @add-javadoc!!!
java.util.Collection	realizeWindowData(java.util.Iterator it, int currentWindow, int windowSize) Method realizeWindowData @add-javadoc!!!
void	setClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor classDescriptor) Sets the classDescriptor.
void	setDispatchProperty(java.lang.String dispatchProperty) Sets the dispatchProperty.
void	setNullValue(java.lang.String nullValue) Sets the nullValue.
void	setPagerFormName(java.lang.String pagerFormName) Sets the pagerFormName.
void	setSelectedformName(java.lang.String selectedformName) Sets the selectedformName.
void	setSizerFormName(java.lang.String sizerFormName) Sets the sizerFormName.
void	setSortAscending(boolean sortAscending) Sets the sortAscending.
void	setSortAscendingName(java.lang.String sortAscendingName) Sets the sortAscendingName.
void	setSortColumn(java.lang.String sortColumn) Sets the sortColumn.
void	setSortColumnName(java.lang.String sortColumnName) Sets the sortColumnName.

Methods inherited from class org.scrashmeow.ojb.console.ui.control.OjbcViewControlFactory

getApplicationService, getRequest, getSelfLink, getSelfParams, getUserLocale, initialize, initialize, setApplicationService, setRequest, setSelfLink, setSelfParams, setUserLocale

Methods inherited from class java.lang.Object

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

Field Detail

nullValue

protected java.lang.String nullValue

Field nullValue

classDescriptor

protected org.apache.ojb.broker.metadata.ClassDescriptor classDescriptor

Field classDescriptor

selectedformName

protected java.lang.String selectedformName

Field selectedformName

pagerFormName

protected java.lang.String pagerFormName

Field pagerFormName

sizerFormName

protected java.lang.String sizerFormName

Field sizerFormName

sortAscendingName

protected java.lang.String sortAscendingName

Field sortAscendingName

dispatchProperty

protected java.lang.String dispatchProperty

Field dispatchProperty

sortColumn

protected java.lang.String sortColumn

Field sortColumn

sortColumnName

protected java.lang.String sortColumnName

Field sortColumnName

sortAscending

protected boolean sortAscending

Field sortAscending

Constructor Detail

SearchGridControlFactory

public SearchGridControlFactory()

Constructor for GridControlFactory.

Method Detail

newInstance

public static SearchGridControlFactory newInstance(ApplicationService service,
                                                   HttpServletRequest request,
                                                   org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                                   java.lang.String selectedFormName,
                                                   java.lang.String pagerFormName,
                                                   java.lang.String sizerFormName,
                                                   java.lang.String dispatchProperty,
                                                   java.lang.String sortColumn,
                                                   java.lang.String sortColumnName,
                                                   boolean sortAscending,
                                                   java.lang.String sortAscendingName)
                                            throws ServiceException

Method newInstance @add-javadoc!!!

Parameters:

service - @add-javadoc!!!

request - @add-javadoc!!!

cld - @add-javadoc!!!

selectedFormName - @add-javadoc!!!

pagerFormName - @add-javadoc!!!

sizerFormName - @add-javadoc!!!

dispatchProperty - @add-javadoc!!!

sortColumn - @add-javadoc!!!

sortColumnName - @add-javadoc!!!

sortAscending - @add-javadoc!!!

sortAscendingName - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createGrid

public GridControl createGrid(java.util.Iterator queryResults,
                              int queryResultSize,
                              int windowSize,
                              int currentWindow)
                       throws ServiceException

Creates a grid control of data. This builds the basics for a grid control w/o adding any link or form related information.

Parameters:

queryResults -

queryResultSize -

windowSize -

currentWindow -

Returns:

GridControl

Throws:

ServiceException - @add-javadoc!!!

getNullValue

public java.lang.String getNullValue()

Returns the nullValue.

Returns:

String

setNullValue

public void setNullValue(java.lang.String nullValue)

Sets the nullValue.

Parameters:

nullValue - The nullValue to set

getClassDescriptor

public org.apache.ojb.broker.metadata.ClassDescriptor getClassDescriptor()

Returns the classDescriptor.

Returns:

ClassDescriptor

setClassDescriptor

public void setClassDescriptor(org.apache.ojb.broker.metadata.ClassDescriptor classDescriptor)

Sets the classDescriptor.

Parameters:

classDescriptor - The classDescriptor to set

createGridHeaders

public java.util.List createGridHeaders()
                                 throws ServiceException

Method buildGridHeaders.

Returns:

List

Throws:

ServiceException - @add-javadoc!!!

createGridRowUid

public java.lang.String createGridRowUid(org.apache.ojb.broker.metadata.ClassDescriptor cld,
                                         java.lang.Object inst,
                                         int index)
                                  throws ServiceException

Method createGridRowUid @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

inst - @add-javadoc!!!

index - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

createGridRows

public java.util.List createGridRows(java.util.Collection gridData,
                                     int currentWindow,
                                     int windowSize)
                              throws ServiceException

Method createGridRows @add-javadoc!!!

Parameters:

gridData - @add-javadoc!!!

currentWindow - @add-javadoc!!!

windowSize - @add-javadoc!!!

Returns:

@add-javadoc!!!

Throws:

ServiceException - @add-javadoc!!!

getBrowseableValue

public java.lang.String getBrowseableValue(java.lang.Object value)
                                    throws ServiceException

ServiceException

createHeaderItem

public GridDataLink createHeaderItem()

Method createHeaderItem @add-javadoc!!!

Returns:

@add-javadoc!!!

createGridControl

public GridControl createGridControl()

Method createGridControl @add-javadoc!!!

Returns:

@add-javadoc!!!

createPager

public GridPager createPager(int currentWindow,
                             int windowCount)

Method createPager @add-javadoc!!!

Parameters:

currentWindow - @add-javadoc!!!

windowCount - @add-javadoc!!!

Returns:

@add-javadoc!!!

realizeWindowData

public java.util.Collection realizeWindowData(java.util.Iterator it,
                                              int currentWindow,
                                              int windowSize)

Method realizeWindowData @add-javadoc!!!

Parameters:

it - @add-javadoc!!!

currentWindow - @add-javadoc!!!

windowSize - @add-javadoc!!!

Returns:

@add-javadoc!!!

createActionBar

public GridActionBar createActionBar(int objectCount)

Method createActionBar @add-javadoc!!!

Parameters:

objectCount - @add-javadoc!!!

Returns:

@add-javadoc!!!

createWindowSizer

public GridWindowSizer createWindowSizer()

Method createWindowSizer @add-javadoc!!!

Returns:

@add-javadoc!!!

calcWindowCount

protected long calcWindowCount(int queryResultSize,
                               int windowSize)

Method calcWindowCount @add-javadoc!!!

Parameters:

queryResultSize - @add-javadoc!!!

windowSize - @add-javadoc!!!

Returns:

@add-javadoc!!!

normalizeCurrentWindow

protected int normalizeCurrentWindow(int currentWindow,
                                     int windowCount)

Method normalizeCurrentWindow @add-javadoc!!!

Parameters:

currentWindow - @add-javadoc!!!

windowCount - @add-javadoc!!!

Returns:

@add-javadoc!!!

calcStartIndex

protected int calcStartIndex(int currentWindow,
                             int windowSize)

Method calcStartIndex @add-javadoc!!!

Parameters:

currentWindow - @add-javadoc!!!

windowSize - @add-javadoc!!!

Returns:

@add-javadoc!!!

determineFieldsToDisplayFlags

protected boolean[] determineFieldsToDisplayFlags(org.apache.ojb.broker.metadata.ClassDescriptor cld)

Method determineFieldsToDisplayFlags @add-javadoc!!!

Parameters:

cld - @add-javadoc!!!

Returns:

@add-javadoc!!!

getDispatchProperty

public java.lang.String getDispatchProperty()

Returns the dispatchProperty.

Returns:

String

getPagerFormName

public java.lang.String getPagerFormName()

Returns the pagerFormName.

Returns:

String

getSelectedformName

public java.lang.String getSelectedformName()

Returns the selectedformName.

Returns:

String

getSizerFormName

public java.lang.String getSizerFormName()

Returns the sizerFormName.

Returns:

String

setDispatchProperty

public void setDispatchProperty(java.lang.String dispatchProperty)

Sets the dispatchProperty.

Parameters:

dispatchProperty - The dispatchProperty to set

setPagerFormName

public void setPagerFormName(java.lang.String pagerFormName)

Sets the pagerFormName.

Parameters:

pagerFormName - The pagerFormName to set

setSelectedformName

public void setSelectedformName(java.lang.String selectedformName)

Sets the selectedformName.

Parameters:

selectedformName - The selectedformName to set

setSizerFormName

public void setSizerFormName(java.lang.String sizerFormName)

Sets the sizerFormName.

Parameters:

sizerFormName - The sizerFormName to set

getSortAscending

public boolean getSortAscending()

Returns the sortAscending.

Returns:

boolean

getSortColumn

public java.lang.String getSortColumn()

Returns the sortColumn.

Returns:

String

setSortAscending

public void setSortAscending(boolean sortAscending)

Sets the sortAscending.

Parameters:

sortAscending - The sortAscending to set

setSortColumn

public void setSortColumn(java.lang.String sortColumn)

Sets the sortColumn.

Parameters:

sortColumn - The sortColumn to set

getSortAscendingName

public java.lang.String getSortAscendingName()

Returns the sortAscendingName.

Returns:

String

getSortColumnName

public java.lang.String getSortColumnName()

Returns the sortColumnName.

Returns:

String

setSortAscendingName

public void setSortAscendingName(java.lang.String sortAscendingName)

Sets the sortAscendingName.

Parameters:

sortAscendingName - The sortAscendingName to set

setSortColumnName

public void setSortColumnName(java.lang.String sortColumnName)

Sets the sortColumnName.

Parameters:

sortColumnName - The sortColumnName to set