de.ipcon.db.event

Class FilteringDBManBOChangeEvent

java.lang.Object

de.ipcon.db.event.DBManEvent

de.ipcon.db.event.DBManBOEvent

de.ipcon.db.event.DBManBOChangeEvent

de.ipcon.db.event.FilteringDBManBOChangeEvent

All Implemented Interfaces:

DBManBOChangeEventI, java.io.Serializable, java.lang.Cloneable

public class FilteringDBManBOChangeEvent
extends DBManBOChangeEvent

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilteringDBManBOChangeEvent(DBManBOChangeEvent _event, DBManEventFilter _filter)

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	getAdditionalInformation() returns the additional information on the client which is already tailored for the current filter this event is delivered for.
BO	getBO(int i)
java.lang.Class	getBOClass(int i)
short	getBOFlag(int i)
long	getBOId(int i)
java.util.List<java.lang.Long>	getBOIdsForClass(java.lang.Class _clazz) Returns the BO-Ids of this event matching the passed class.
java.util.List<java.lang.Long>	getBOIdsForClass(java.lang.Class _clazz, short bOFlag) Returns the Ids of all BOs in this event matching the passed class and flag.
java.util.List<java.lang.Long>	getBOIdsForClasses(java.lang.Class[] _clazzes) Returns the BO-Ids of this event matching any of the passed classes.
java.util.List<java.lang.Long>	getBOIdsForClasses(java.lang.Class[] _clazzes, short bOFlag) Returns the Ids of all BOs in this event matching any of the passed classes and flag.
java.util.List<BO>	getBOs(BOLoaderI _bol) Loads and returns the BOs of this event.
java.util.List<BO>	getBOs(BOLoaderI _bol, java.lang.Class _clazz)
java.util.List	getBOs(BOLoaderI _bol, java.lang.Class _clazz, boolean _onlyChanged) Loads and returns the changed BOs of this event.
java.util.List	getBOs(BOLoaderI _bol, java.lang.Class _clazz, short bOFlag) Loads and returns the BOs of this event matching the passed flag.
LazyBOReference[]	getBOsAsLazyBOReferences(BOLoaderI _bol) Used for NotificationModule to avoid unnecessary object creation (and might probably be useful elsewhere too, so placed this method here instead of in NotificationModule).
LazyBOReference[]	getBOsAsLazyBOReferences(BOLoaderI _bol, java.lang.Class _clazz)
LazyBOReference[]	getBOsAsLazyBOReferences(BOLoaderI _bol, java.lang.Class _clazz, boolean _created)
LazyBOReference[]	getBOsAsLazyBOReferences(BOLoaderI _bol, java.lang.Class _clazz, boolean _created, boolean _changed)
LazyBOReference[]	getBOsAsLazyBOReferences(BOLoaderI _bol, java.lang.Class _clazz, boolean _created, boolean _changed, boolean _deleted)
BT	getBT(int i)
int	getBTsSize()
java.util.List<java.lang.Long>	getChangedBOIds(java.lang.Class _clazz) Returns the Ids of all changed BOs in this event matching the passed class.
java.util.List<java.lang.Long>	getChangedBOIds(java.lang.Class[] _clazzes) Returns the Ids of all changed BOs in this event matching any of the passed classes.
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String _attrName)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String[] _attrNames) Load all BOs that were changed by this event with the given loader and return them.
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String[] _attrNames, boolean _lazy)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String[] _attrNames, boolean _lazy, boolean _warnSlow)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String[] _attrNames, boolean _lazy, boolean _warnSlow, boolean _includeDeletions)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String _attrName, boolean _lazy)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String _attrName, boolean _lazy, boolean _warnSlow)
java.util.Map<java.lang.Long,FlagStore>	getChangedBOs(BOLoaderI _bol, java.lang.Class _clazz, java.lang.String _attrName, boolean _lazy, boolean _warnSlow, boolean _includeDeletions)
java.util.Map	getCreatedBOs(BOLoaderI _bol) Loads and returns the newly created BOs of this event.
java.util.Map	getCreatedBOs(BOLoaderI _bol, java.lang.Class _clazz)
java.util.Map	getCreatedBOs(BOLoaderI _bol, java.lang.Class _clazz, boolean _includeUndeletions)
java.lang.String	getDescription()
DBManEvent	getFilteringInstance(DBManEventFilter f) Used on client- and server-side for getting an event which only returns the data actually requested in the passed filter, possibly enriched with additional information calculated by an optional server-side information calculator.
long[]	getNodeIds()
int	getSize()
long[]	getTxIds()
int	getType()
java.util.Map<java.lang.Long,Benutzer>	getUsers(BOLoaderI _bol) Returns all users which are involved in Transactions included in this event
java.lang.Boolean	isFromNode(long _nodeNumber) Checks whether this Event contains a Transaction which originated on the node with the given number.
boolean	isOneOfClass(java.lang.Class _clazz) Tells if this event concerns an object of the given class (including subclasses).
boolean	isOneOfClasses(java.lang.Class[] _clazzes) Tells if this event concerns an object of one of the given classes (including subclasses).
boolean	isOnlyTriggeredBy(Benutzer user) Delegates to the real event, including unfiltered TXs, because the accessed attributes are not used for filtered events
boolean	isTriggeredBy(Benutzer _user) Delegates to the real event, including unfiltered TXs, because the accessed attributes are not used for filtered events
void	markForTrimming(DBManEventFilter f) (possibly) builds and fills a boolean-array with markers at the indices at which actually requested, i.e. fitting, objects are found in this event or sets noTrimming if no filter is passed
DBManEvent	trim() uses the information stored by markForTrimming in the passed event e (either noTrimming or requestedInAnyFilter) to trim down the data in this event
boolean	wasChanged(int i)
boolean	wasCreated(int i)
boolean	wasDeleted(int i)
boolean	wasUndeleted(int i)

Methods inherited from class de.ipcon.db.event.DBManBOChangeEvent

addServerSideCalculatedInformation, getBOs, getBPsByBOId, getBPsGroupedByBOId, getRelevantIndices, getServerSideCalculatedInformationForClass, getServerSideCalculatedInformationForClasses, isFromUs, of

Methods inherited from class de.ipcon.db.event.DBManBOEvent

isEmpty

Methods inherited from class de.ipcon.db.event.DBManEvent

clone, getServerNodeNumber, getServerSideCalculatedInformation, getTrimmedSize, setServerNodeNumber, setServerSideCalculatedInformation

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteringDBManBOChangeEvent

public FilteringDBManBOChangeEvent(DBManBOChangeEvent _event,
                                   DBManEventFilter _filter)

Method Detail

getFilteringInstance

public DBManEvent getFilteringInstance(DBManEventFilter f)

Description copied from class: DBManEvent

Used on client- and server-side for getting an event which only returns the data actually requested in the passed filter, possibly enriched with additional information calculated by an optional server-side information calculator.

Overrides:

getFilteringInstance in class DBManBOChangeEvent

getAdditionalInformation

public java.lang.Object[] getAdditionalInformation()

Description copied from class: DBManEvent

returns the additional information on the client which is already tailored for the current filter this event is delivered for. Should only get called in filtering-instance.

Overrides:

getAdditionalInformation in class DBManEvent

getSize

public int getSize()

Specified by:

getSize in interface DBManBOChangeEventI

Overrides:

getSize in class DBManBOChangeEvent

Returns:

the number of BOs modified by this event, zero if there are no changes.

getBO

public BO getBO(int i)

Overrides:

getBO in class DBManBOEvent

Returns:

the BO modified with index i from this event. Parameter is limited to 0...DBManBOEvent.getSize()-1

getBOId

public long getBOId(int i)

Specified by:

getBOId in interface DBManBOChangeEventI

Overrides:

getBOId in class DBManBOEvent

Returns:

the Id of the BO with index i from this event. Parameter is limited to 0...DBManBOEvent.getSize()-1

getBOClass

public java.lang.Class getBOClass(int i)

Specified by:

getBOClass in interface DBManBOChangeEventI

Overrides:

getBOClass in class DBManBOEvent

Returns:

the Class of the BO with index i from this event. Parameter is limited to 0...DBManBOEvent.getSize()-1

getBOFlag

public short getBOFlag(int i)

Overrides:

getBOFlag in class DBManBOChangeEvent

getType

public int getType()

Overrides:

getType in class DBManBOChangeEvent

getDescription

public java.lang.String getDescription()

Overrides:

getDescription in class DBManBOChangeEvent

getBTsSize

public int getBTsSize()

Overrides:

getBTsSize in class DBManBOChangeEvent

getBT

public BT getBT(int i)

Overrides:

getBT in class DBManBOChangeEvent

getTxIds

public long[] getTxIds()

Specified by:

getTxIds in interface DBManBOChangeEventI

Overrides:

getTxIds in class DBManBOChangeEvent

getNodeIds

public long[] getNodeIds()

Overrides:

getNodeIds in class DBManBOChangeEvent

isOneOfClass

public boolean isOneOfClass(java.lang.Class _clazz)

Description copied from class: DBManBOEvent

Tells if this event concerns an object of the given class (including subclasses).

Overrides:

isOneOfClass in class DBManBOEvent

Parameters:

_clazz - The class of which we want objects of.

Returns:

true if at least one of the objects that this event concerns is of the given clazz or a subclass thereof, false otherwise.

isOneOfClasses

public boolean isOneOfClasses(java.lang.Class[] _clazzes)

Description copied from class: DBManBOEvent

Tells if this event concerns an object of one of the given classes (including subclasses).

Overrides:

isOneOfClasses in class DBManBOEvent

Parameters:

_clazzes - The classes of which we want objects of.

Returns:

true if at least one of the objects that this event concerns is one of the given clazzes or a subclass thereof, false otherwise.

isTriggeredBy

public boolean isTriggeredBy(Benutzer _user)

Delegates to the real event, including unfiltered TXs, because the accessed attributes are not used for filtered events

Specified by:

isTriggeredBy in interface DBManBOChangeEventI

Overrides:

isTriggeredBy in class DBManBOChangeEvent

Parameters:

_user - The user to check against this Event

Returns:

true or false

isOnlyTriggeredBy

public boolean isOnlyTriggeredBy(Benutzer user)

Delegates to the real event, including unfiltered TXs, because the accessed attributes are not used for filtered events

Specified by:

isOnlyTriggeredBy in interface DBManBOChangeEventI

Overrides:

isOnlyTriggeredBy in class DBManBOChangeEvent

Parameters:

user - the user to check against this Event

Returns:

true if all BTs in this event are triggered by the provided user or false, if the given user is null, no userIds are available or at least one BT was saved by another user.

isFromNode

public java.lang.Boolean isFromNode(long _nodeNumber)

Description copied from class: DBManBOChangeEvent

Checks whether this Event contains a Transaction which originated on the node with the given number.

Overrides:

isFromNode in class DBManBOChangeEvent

Parameters:

_nodeNumber - The number of the node to check against this Event

Returns:

Boolean.TRUE if all TX of this event originated from node, Boolean.FALSE if all TX originated from other nodes, null if some TX from node and some from others.

getUsers

public java.util.Map<java.lang.Long,Benutzer> getUsers(BOLoaderI _bol)

Description copied from class: DBManBOChangeEvent

Returns all users which are involved in Transactions included in this event

Overrides:

getUsers in class DBManBOChangeEvent

Parameters:

_bol - A BOLoader to load the users

Returns:

All users in this Event

getBOIdsForClass

public java.util.List<java.lang.Long> getBOIdsForClass(java.lang.Class _clazz)

Description copied from class: DBManBOEvent

Returns the BO-Ids of this event matching the passed class.

Overrides:

getBOIdsForClass in class DBManBOEvent

Parameters:

_clazz - return only BO-Ids of this class (including subclasses)

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getBOIdsForClasses

public java.util.List<java.lang.Long> getBOIdsForClasses(java.lang.Class[] _clazzes)

Description copied from class: DBManBOEvent

Returns the BO-Ids of this event matching any of the passed classes.

Overrides:

getBOIdsForClasses in class DBManBOEvent

Parameters:

_clazzes - return only BO-Ids of these classes (including subclasses)

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getBOs

public java.util.List<BO> getBOs(BOLoaderI _bol)

Description copied from class: DBManBOEvent

Loads and returns the BOs of this event.

Overrides:

getBOs in class DBManBOEvent

Parameters:

_bol - the BOLoaderI which should be used for loading the BOs.

Returns:

an ArrayList with the BOs of this event.

getBOs

public java.util.List<BO> getBOs(BOLoaderI _bol,
                                 java.lang.Class _clazz)

Overrides:

getBOs in class DBManBOEvent

markForTrimming

public void markForTrimming(DBManEventFilter f)

Description copied from class: DBManBOChangeEvent

(possibly) builds and fills a boolean-array with markers at the indices at which actually requested, i.e. fitting, objects are found in this event or sets noTrimming if no filter is passed

Overrides:

markForTrimming in class DBManBOChangeEvent

trim

public DBManEvent trim()

Description copied from class: DBManBOChangeEvent

uses the information stored by markForTrimming in the passed event e (either noTrimming or requestedInAnyFilter) to trim down the data in this event

Overrides:

trim in class DBManBOChangeEvent

getCreatedBOs

public java.util.Map getCreatedBOs(BOLoaderI _bol)

Description copied from class: DBManBOChangeEvent

Loads and returns the newly created BOs of this event. BOs are wrapped in a FlagStore object that additionally provides an overview on the type of recorded changes by this event.

Specified by:

getCreatedBOs in interface DBManBOChangeEventI

Overrides:

getCreatedBOs in class DBManBOChangeEvent

Parameters:

_bol - a BOLoaderI which will (only) be used to getBOs() and as a "cache" for the BOs that are loaded this way.

Returns:

a nonnull Map with the FlagStore objects for the new BOs of this event, with BO Ids as keys.

getCreatedBOs

public java.util.Map getCreatedBOs(BOLoaderI _bol,
                                   java.lang.Class _clazz)

Specified by:

getCreatedBOs in interface DBManBOChangeEventI

Overrides:

getCreatedBOs in class DBManBOChangeEvent

getCreatedBOs

public java.util.Map getCreatedBOs(BOLoaderI _bol,
                                   java.lang.Class _clazz,
                                   boolean _includeUndeletions)

Overrides:

getCreatedBOs in class DBManBOChangeEvent

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI _bol)

Description copied from class: DBManBOChangeEvent

Used for NotificationModule to avoid unnecessary object creation (and might probably be useful elsewhere too, so placed this method here instead of in NotificationModule).

Overrides:

getBOsAsLazyBOReferences in class DBManBOChangeEvent

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI _bol,
                                                  java.lang.Class _clazz)

Overrides:

getBOsAsLazyBOReferences in class DBManBOChangeEvent

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI _bol,
                                                  java.lang.Class _clazz,
                                                  boolean _created)

Overrides:

getBOsAsLazyBOReferences in class DBManBOChangeEvent

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI _bol,
                                                  java.lang.Class _clazz,
                                                  boolean _created,
                                                  boolean _changed)

Overrides:

getBOsAsLazyBOReferences in class DBManBOChangeEvent

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI _bol,
                                                  java.lang.Class _clazz,
                                                  boolean _created,
                                                  boolean _changed,
                                                  boolean _deleted)

Overrides:

getBOsAsLazyBOReferences in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol)

Specified by:

getChangedBOs in interface DBManBOChangeEventI

Overrides:

getChangedBOs in class DBManBOChangeEvent

See Also:

#getChangedBOs(BOLOaderI, Class, String[], boolean, boolean, boolean)

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz)

Specified by:

getChangedBOs in interface DBManBOChangeEventI

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String _attrName)

Specified by:

getChangedBOs in interface DBManBOChangeEventI

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String _attrName,
                                                             boolean _lazy)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String _attrName,
                                                             boolean _lazy,
                                                             boolean _warnSlow)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String _attrName,
                                                             boolean _lazy,
                                                             boolean _warnSlow,
                                                             boolean _includeDeletions)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String[] _attrNames)

Description copied from class: DBManBOChangeEvent

Load all BOs that were changed by this event with the given loader and return them. Supports various filters.

Overrides:

getChangedBOs in class DBManBOChangeEvent

Parameters:

_bol - the nonnull BOLoader to load matching BOs with.

_clazz - only instances of the given class are returned, null to disable this allowlist-filter.

_attrNames - only include BOs if one of the given attribute names were changed. Names are only checked against changes and do not have to exist on all applicable BOs.

Returns:

a nonnull Map with applicable BO-Ids as key and the FlagStore for and with this loaded BO as value.

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String[] _attrNames,
                                                             boolean _lazy)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String[] _attrNames,
                                                             boolean _lazy,
                                                             boolean _warnSlow)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI _bol,
                                                             java.lang.Class _clazz,
                                                             java.lang.String[] _attrNames,
                                                             boolean _lazy,
                                                             boolean _warnSlow,
                                                             boolean _includeDeletions)

Overrides:

getChangedBOs in class DBManBOChangeEvent

getChangedBOIds

public java.util.List<java.lang.Long> getChangedBOIds(java.lang.Class _clazz)

Description copied from class: DBManBOChangeEvent

Returns the Ids of all changed BOs in this event matching the passed class.

Overrides:

getChangedBOIds in class DBManBOChangeEvent

Parameters:

_clazz - return only BO-Ids of this class (including subclasses)

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getChangedBOIds

public java.util.List<java.lang.Long> getChangedBOIds(java.lang.Class[] _clazzes)

Description copied from class: DBManBOChangeEvent

Returns the Ids of all changed BOs in this event matching any of the passed classes.

Overrides:

getChangedBOIds in class DBManBOChangeEvent

Parameters:

_clazzes - return only BO-Ids of these classes (including subclasses)

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getBOIdsForClass

public java.util.List<java.lang.Long> getBOIdsForClass(java.lang.Class _clazz,
                                                       short bOFlag)

Description copied from class: DBManBOChangeEvent

Returns the Ids of all BOs in this event matching the passed class and flag.

Overrides:

getBOIdsForClass in class DBManBOChangeEvent

Parameters:

_clazz - return only BO-Ids of this class (including subclasses)

bOFlag - return only BO-Ids of BOs which have any of these or-ed FlagStore.FLAG_*

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getBOIdsForClasses

public java.util.List<java.lang.Long> getBOIdsForClasses(java.lang.Class[] _clazzes,
                                                         short bOFlag)

Description copied from class: DBManBOChangeEvent

Returns the Ids of all BOs in this event matching any of the passed classes and flag.

Overrides:

getBOIdsForClasses in class DBManBOChangeEvent

Parameters:

_clazzes - return only BO-Ids of these classes (including subclasses)

bOFlag - return only BO-Ids of BOs which have any of these or-ed FlagStore.FLAG_*

Returns:

an ArrayList with the BO-Ids of this event matching the criteria.

getBOs

public java.util.List getBOs(BOLoaderI _bol,
                             java.lang.Class _clazz,
                             boolean _onlyChanged)

Description copied from class: DBManBOChangeEvent

Loads and returns the changed BOs of this event.

Overrides:

getBOs in class DBManBOChangeEvent

Parameters:

_bol - the BOLoaderI which should be used for loading the BOs.

_clazz - if given/not null tells that only BOs of this class (including subclasses) should be loaded and returned; if not given/null all BOs will be loaded.

Returns:

an ArrayList with the BOs of this event.

getBOs

public java.util.List getBOs(BOLoaderI _bol,
                             java.lang.Class _clazz,
                             short bOFlag)

Description copied from class: DBManBOChangeEvent

Loads and returns the BOs of this event matching the passed flag.

Overrides:

getBOs in class DBManBOChangeEvent

Parameters:

_bol - the BOLoaderI which should be used for loading the BOs.

_clazz - if given/not null tells that only BOs of this class (including subclasses) should be loaded and returned; if not given/null all BOs will be loaded.

bOFlag - return only BO-Ids of BOs which have any of these or-ed FlagStore.FLAG_*

Returns:

an ArrayList with the BOs of this event.

wasChanged

public boolean wasChanged(int i)

Overrides:

wasChanged in class DBManBOChangeEvent

wasCreated

public boolean wasCreated(int i)

Overrides:

wasCreated in class DBManBOChangeEvent

wasDeleted

public boolean wasDeleted(int i)

Overrides:

wasDeleted in class DBManBOChangeEvent

wasUndeleted

public boolean wasUndeleted(int i)

Overrides:

wasUndeleted in class DBManBOChangeEvent