er.extensions.appserver

Class ERXDisplayGroup<T>

java.lang.Object

com.webobjects.appserver.WODisplayGroup

er.extensions.appserver.ERXDisplayGroup<T>

Type Parameters:

T - data type of the displaygroup's objects

All Implemented Interfaces:

com.webobjects.eocontrol.EOKeyValueArchiving, com.webobjects.eocontrol.EOKeyValueArchiving.Awaking, com.webobjects.foundation.NSDisposable, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, Serializable

Direct Known Subclasses:

ERXBatchingDisplayGroup

public class ERXDisplayGroup<T>
extends WODisplayGroup

Extends WODisplayGroup

• provide access to the filtered objects
• allows you to add qualifiers to the final query qualifier (as opposed to just min/equals/max with the keys)
• clears out the sort ordering when the datasource changes. This is a cure fix to prevent errors when using switch components.

Selections and usage with Datasource

If you are using the display group with a datasource and changing the selection by setSelectedObjects(NSArray) only matching objects in the displayed objects will be selected and the events displayGroupShouldChangeSelectionToIndexes, displayGroupDidChangeSelectedObjects and displayGroupDidChangeSelection will be triggered.

Selections and usage without Datasource

If you are using plain arrays to fill your display group and set a selection by setSelectedObjects(NSArray) you won't get related events as with a datasource. Also the selection is not matched against the displayed objects but set directly.

See Also:

Serialized Form

Author:

ak

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WODisplayGroup

WODisplayGroup.Delegate

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.DefaultImplementation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.MapImplementation, com.webobjects.foundation.NSKeyValueCoding.Null<T>, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.Utility, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

com.webobjects.eocontrol.EOKeyValueArchiving._NullValueSupport, com.webobjects.eocontrol.EOKeyValueArchiving._NumberSupport, com.webobjects.eocontrol.EOKeyValueArchiving._TimestampSupport, com.webobjects.eocontrol.EOKeyValueArchiving.Awaking, com.webobjects.eocontrol.EOKeyValueArchiving.FinishInitialization, com.webobjects.eocontrol.EOKeyValueArchiving.Support

Field Summary

Fields inherited from class com.webobjects.appserver.WODisplayGroup

DisplayGroupWillFetchNotification

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

_CLASS, NullValue

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSDisposable

_CLASS

Fields inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving

_CLASS

Fields inherited from interface com.webobjects.eocontrol.EOKeyValueArchiving.Awaking

_CLASS

Constructor Summary

Constructors

Constructor and Description
ERXDisplayGroup()

Method Summary

Modifier and Type	Method and Description
boolean	addToSelection(NSArray<T> objects) Extends the current selection by the given objects.
boolean	addToSelection(T object) Extends the current selection by the given object.
NSArray<T>	allObjects()
NSArray<String>	allQualifierOperators()
void	clearExtraQualifiers()
static Object	decodeWithKeyValueUnarchiver(com.webobjects.eocontrol.EOKeyValueUnarchiver unarchiver) Decodes an ERXDisplayGroup from the given unarchiver.
NSArray<T>	displayedObjects()
Object	displayNextBatch() Overridden to preserve the current selection.
Object	displayPreviousBatch() Overridden to preserve the current selection.
Object	fetch() Overridden to localize the fetch specification if needed.
NSArray<T>	filteredObjects() Returns all objects, filtered by the qualifier().
int	indexOfFirstDisplayedObject() Overridden to return correct result when no objects are displayed
int	indexOfLastDisplayedObject() Overridden to return correct index if the number of filtered objects is not a multiple of numberOfObjectsPerBatch and we are on the last batch index.
com.webobjects.eocontrol.EOQualifier	qualifierForKey(String key) Will return the qualifier set by "setQualifierForKey()" if it exists.
com.webobjects.eocontrol.EOQualifier	qualifierFromQueryValues() Overridden to support extra qualifiers.
boolean	removeFromSelection(NSArray<T> objects) Removes the given objects from the current selection.
boolean	removeFromSelection(T object) Removes the given object from the current selection.
T	selectedObject()
NSArray<T>	selectedObjects()
Object	selectFilteredObjects() Selects the visible objects.
void	setDataSource(com.webobjects.eocontrol.EODataSource ds) Overridden to clear out the sort ordering if it is no longer applicable.
void	setNumberOfObjectsPerBatch(int count) Overridden to preserve the current selection.
void	setQualifier(com.webobjects.eocontrol.EOQualifier qualifier)
void	setQualifierForKey(com.webobjects.eocontrol.EOQualifier qualifier, String key)
void	setSelectedObjects(NSArray objects)
boolean	setSelectionIndexes(NSArray nsarray)
void	setSortOrderings(NSArray<com.webobjects.eocontrol.EOSortOrdering> sortOrderings) Overridden to log a message when more than one sort order exists.
NSArray<T>	sortedObjects() Returns allObjects(), first filtered by the qualifier(), then sorted by the sortOrderings().
NSArray<com.webobjects.eocontrol.EOSortOrdering>	sortOrderings()

Methods inherited from class com.webobjects.appserver.WODisplayGroup

_beginObserverNotification, _deleteObject, _insertObjectAtIndex, _lastObserverNotified, awakeFromKeyValueUnarchiver, batchCount, clearSelection, currentBatchIndex, dataSource, defaultStringMatchFormat, defaultStringMatchOperator, delegate, delete, deleteObjectAtIndex, deleteSelection, detailKey, displayBatchContainingSelectedObject, dispose, editingContextPresentErrorMessage, encodeWithCoder, encodeWithKeyValueArchiver, endEditing, fetchesOnLoad, finishInitialization, globalDefaultForValidatesChangesImmediately, globalDefaultStringMatchFormat, globalDefaultStringMatchOperator, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasDetailDataSource, hasMultipleBatches, initWithCoder, inQueryMode, insert, insertedObjectDefaultValues, insertNewObjectAtIndex, insertObjectAtIndex, localKeys, masterObject, numberOfObjectsPerBatch, objectsChangedInEditingContext, objectsInvalidatedInEditingContext, qualifier, qualifyDataSource, qualifyDisplayGroup, queryBindings, queryMatch, queryMax, queryMin, queryOperator, redisplay, relationalQualifierOperators, selectionIndexes, selectNext, selectObject, selectObjectsIdenticalTo, selectObjectsIdenticalToSelectFirstOnNoMatch, selectPrevious, selectsFirstObjectAfterFetch, setCurrentBatchIndex, setDefaultStringMatchFormat, setDefaultStringMatchOperator, setDelegate, setDetailKey, setFetchesOnLoad, setGlobalDefaultForValidatesChangesImmediately, setGlobalDefaultStringMatchFormat, setGlobalDefaultStringMatchOperator, setInQueryMode, setInsertedObjectDefaultValues, setLocalKeys, setMasterObject, setObjectArray, setSelectedObject, setSelectsFirstObjectAfterFetch, setValidatesChangesImmediately, stringQualifierOperators, takeValueForKey, toString, unableToSetNullForKey, undoManager, updateDisplayedObjects, validatesChangesImmediately, valueForKey, willChange

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXDisplayGroup

public ERXDisplayGroup()

Method Detail

decodeWithKeyValueUnarchiver

public static Object decodeWithKeyValueUnarchiver(com.webobjects.eocontrol.EOKeyValueUnarchiver unarchiver)

Decodes an ERXDisplayGroup from the given unarchiver.

Parameters:

unarchiver - the unarchiver to construct this display group with

Returns:

the corresponding batching display group

setQualifierForKey

public void setQualifierForKey(com.webobjects.eocontrol.EOQualifier qualifier,
                               String key)

qualifierForKey

public com.webobjects.eocontrol.EOQualifier qualifierForKey(String key)

Will return the qualifier set by "setQualifierForKey()" if it exists. Null returns otherwise.

Parameters:

key -

Returns:

qualifierFromQueryValues

public com.webobjects.eocontrol.EOQualifier qualifierFromQueryValues()

Overridden to support extra qualifiers.

Overrides:

qualifierFromQueryValues in class WODisplayGroup

Returns:

the qualifier constructed

fetch

public Object fetch()

Overridden to localize the fetch specification if needed.

Overrides:

fetch in class WODisplayGroup

Returns:

null to force the page to reload

setQualifier

public void setQualifier(com.webobjects.eocontrol.EOQualifier qualifier)

Overrides:

setQualifier in class WODisplayGroup

filteredObjects

public NSArray<T> filteredObjects()

Returns all objects, filtered by the qualifier().

Returns:

filtered objects

sortedObjects

public NSArray<T> sortedObjects()

Returns allObjects(), first filtered by the qualifier(), then sorted by the sortOrderings().

Returns:

sorted filtered objects

selectedObjects

public NSArray<T> selectedObjects()

Overrides:

selectedObjects in class WODisplayGroup

setSelectedObjects

public void setSelectedObjects(NSArray objects)

Overrides:

setSelectedObjects in class WODisplayGroup

setSelectionIndexes

public boolean setSelectionIndexes(NSArray nsarray)

Overrides:

setSelectionIndexes in class WODisplayGroup

addToSelection

public boolean addToSelection(T object)

Extends the current selection by the given object.

Parameters:

object - object to add to the selection

Returns:

true if the object was added or false otherwise

addToSelection

public boolean addToSelection(NSArray<T> objects)

Extends the current selection by the given objects.

Parameters:

objects - objects to add to the selection

Returns:

true if at least one object was added or false otherwise

removeFromSelection

public boolean removeFromSelection(T object)

Removes the given object from the current selection.

Parameters:

object - object to remove from the selection

Returns:

true if the object was removed or false otherwise

removeFromSelection

public boolean removeFromSelection(NSArray<T> objects)

Removes the given objects from the current selection.

Parameters:

objects - objects to remove from the selection

Returns:

true if at least one object was removed or false otherwise

setNumberOfObjectsPerBatch

public void setNumberOfObjectsPerBatch(int count)

Overridden to preserve the current selection.

Overrides:

setNumberOfObjectsPerBatch in class WODisplayGroup

Parameters:

count - the proposed number of objects the WODisplayGroup should display at a time

setDataSource

public void setDataSource(com.webobjects.eocontrol.EODataSource ds)

Overridden to clear out the sort ordering if it is no longer applicable.

Overrides:

setDataSource in class WODisplayGroup

Parameters:

ds - the proposed EODataSource

displayNextBatch

public Object displayNextBatch()

Overridden to preserve the current selection.

Overrides:

displayNextBatch in class WODisplayGroup

Returns:

null to force the page to reload

displayPreviousBatch

public Object displayPreviousBatch()

Overridden to preserve the current selection.

Overrides:

displayPreviousBatch in class WODisplayGroup

Returns:

null to force the page to reload

selectFilteredObjects

public Object selectFilteredObjects()

Selects the visible objects.

Returns:

null to force the page to reload

setSortOrderings

public void setSortOrderings(NSArray<com.webobjects.eocontrol.EOSortOrdering> sortOrderings)

Overridden to log a message when more than one sort order exists. Useful to track down errors.

Overrides:

setSortOrderings in class WODisplayGroup

Parameters:

sortOrderings - the proposed EOSortOrdering objects

clearExtraQualifiers

public void clearExtraQualifiers()

allObjects

public NSArray<T> allObjects()

Overrides:

allObjects in class WODisplayGroup

allQualifierOperators

public NSArray<String> allQualifierOperators()

Overrides:

allQualifierOperators in class WODisplayGroup

displayedObjects

public NSArray<T> displayedObjects()

Overrides:

displayedObjects in class WODisplayGroup

selectedObject

public T selectedObject()

Overrides:

selectedObject in class WODisplayGroup

sortOrderings

public NSArray<com.webobjects.eocontrol.EOSortOrdering> sortOrderings()

Overrides:

sortOrderings in class WODisplayGroup

indexOfFirstDisplayedObject

public int indexOfFirstDisplayedObject()

Overridden to return correct result when no objects are displayed

Overrides:

indexOfFirstDisplayedObject in class WODisplayGroup

Returns:

the index of the first object displayed by the current batch

indexOfLastDisplayedObject

public int indexOfLastDisplayedObject()

Overridden to return correct index if the number of filtered objects is not a multiple of numberOfObjectsPerBatch and we are on the last batch index. The superclass incorrectly uses allObjects instead of displayedObjects to determine the index value.

Overrides:

indexOfLastDisplayedObject in class WODisplayGroup

Returns:

the index of the last object displayed by the current batch