de.ipcon.db.event

Class DBManBOChangeEvent

java.lang.Object

de.ipcon.db.event.DBManEvent

de.ipcon.db.event.DBManBOEvent

de.ipcon.db.event.DBManBOChangeEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

FilteringDBManBOChangeEvent

public class DBManBOChangeEvent
extends DBManBOEvent
implements DBManBOChangeEventI

Events of this class are created/triggered when some Transaction has successfully been saved, that is one or more BOs have changed. Can be used for example to keep a cache on the client side in-sync.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DBManBOChangeEvent(long[] _txIds, long[] _nodeIds, long[] _bOIds, java.lang.Class[] _bOClasses, short[] _bOFlags, BO[] _bOs)

Method Summary

Modifier and Type	Method and Description
void	addServerSideCalculatedInformation(DBManEventFilter f) adds any server-side calculated information being calculated using the passed DBManEventFilter, stored in the map serverSideCalculatedInformation using DBManEventFilter.toString() as key
short	getBOFlag(int i)
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, short bOFlag) Returns the Ids of all BOs in this event matching any of the passed classes and flag.
java.util.List	getBOs(BOLoaderI bol, java.lang.Class[] clazzes, short bOFlag) Loads and returns the BOs of this event matching the passed flag and classes.
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)
java.util.Map<java.lang.Long,BP>	getBPsByBOId(java.lang.Long boId) Return all BPs from the linked BTs for a BO of the given Id
java.util.Map<java.lang.Long,java.util.Collection<BP>>	getBPsGroupedByBOId(java.lang.Class<? extends BOI> onlyForBOClass) Return a map of BO Ids linked to a collection of BPs for the BO Id, for each BO of the given type or all BOs in this event
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<java.lang.Long,FlagStore>	getCreatedBOs(BOLoaderI bol) Loads and returns the newly created BOs of this event.
java.util.Map<java.lang.Long,FlagStore>	getCreatedBOs(BOLoaderI bol, java.lang.Class clazz)
java.util.Map<java.lang.Long,FlagStore>	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()
java.util.Optional<java.lang.Object>	getOldValue(BOLoaderI bol, java.lang.Long id, AttributeI attr, java.lang.Object explicitNullValue) Fetches the old value of the given BO and Attribute from the provided event.
java.util.Optional<java.lang.Object>	getOldValue(BOLoaderI bol, java.lang.Long id, AttributeI attr, java.lang.Object explicitNullValue, boolean allowIndirectChanges)
int[]	getRelevantIndices(DBManEventFilter f) returns an int-array containing all indices at which actually requested, i.e. fitting, objects are found in this event
java.lang.Object[]	getServerSideCalculatedInformationForClass(java.lang.Class clazz, DBManEventFilter f)
java.lang.Object[]	getServerSideCalculatedInformationForClasses(java.lang.Class[] clazzes, DBManEventFilter f)
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.
java.lang.Boolean	isFromUs()
boolean	isOnlyTriggeredBy(Benutzer user) Checks whether this event contains only Transactions and changes made by the given user.
boolean	isTriggeredBy(Benutzer user) Checks whether this Event contains a Transaction which is assigned to the given user
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
static DBManBOChangeEvent	of(TransactionConflictReport tcr, Transaction tx) Initializes a new event from the given tcr and tx and returns it.
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.DBManBOEvent

getBO, getBOClass, getBOId, getBOIdsForClass, getBOIdsForClasses, getBOs, getBOs, isEmpty, isOneOfClass, isOneOfClasses

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

clone, getAdditionalInformation, getServerNodeNumber, getServerSideCalculatedInformation, getTrimmedSize, setServerNodeNumber, setServerSideCalculatedInformation

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.core.DBManBOChangeEventI

getBOClass, getBOId

Constructor Detail

DBManBOChangeEvent

public DBManBOChangeEvent(long[] _txIds,
                          long[] _nodeIds,
                          long[] _bOIds,
                          java.lang.Class[] _bOClasses,
                          short[] _bOFlags,
                          BO[] _bOs)

Method Detail

of

public static DBManBOChangeEvent of(TransactionConflictReport tcr,
                                    Transaction tx)

Initializes a new event from the given tcr and tx and returns it. FIXME! do we really need to seperately pass tx? isn't that always tcr.tx?

getSize

public int getSize()

Specified by:

getSize in interface DBManBOChangeEventI

Overrides:

getSize in class DBManBOEvent

Returns:

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

getTxIds

public long[] getTxIds()

Specified by:

getTxIds in interface DBManBOChangeEventI

getNodeIds

public long[] getNodeIds()

isFromNode

public java.lang.Boolean isFromNode(long nodeNumber)

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

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.

isFromUs

public java.lang.Boolean isFromUs()

Specified by:

isFromUs in interface DBManBOChangeEventI

Returns:

true if the event originated only on the same Node as the current connection, false if only on other Node(s), null if the event contains multiple BTs that were created on 'our' and other nodes.

isTriggeredBy

public boolean isTriggeredBy(Benutzer user)

Checks whether this Event contains a Transaction which is assigned to the given user

Specified by:

isTriggeredBy in interface DBManBOChangeEventI

Parameters:

user - The user to check against this Event

Returns:

true or false

isOnlyTriggeredBy

public boolean isOnlyTriggeredBy(Benutzer user)

Checks whether this event contains only Transactions and changes made by the given user. Expected use are efficient blacklisting of Events originating from the Service that needs to modify BOs it also listens to. e.g. if (event.isFromUs() && event.isOnlyTriggeredBy(api.getCurrentUser())) return;

Specified by:

isOnlyTriggeredBy in interface DBManBOChangeEventI

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.

getUsers

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

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

Parameters:

bol - A BOLoader to load the users

Returns:

All users in this Event

getBTsSize

public int getBTsSize()

getBT

public BT getBT(int i)

getBPsByBOId

public java.util.Map<java.lang.Long,BP> getBPsByBOId(java.lang.Long boId)

Return all BPs from the linked BTs for a BO of the given Id

Parameters:

boId -

Returns:

getBPsGroupedByBOId

public java.util.Map<java.lang.Long,java.util.Collection<BP>> getBPsGroupedByBOId(java.lang.Class<? extends BOI> onlyForBOClass)

Return a map of BO Ids linked to a collection of BPs for the BO Id, for each BO of the given type or all BOs in this event

Parameters:

onlyForBOClass - the BO Ids are filtered by this type

Returns:

a map of BO Ids and their procs

getBOFlag

public short getBOFlag(int i)

getType

public int getType()

Specified by:

getType in class DBManEvent

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class DBManEvent

getCreatedBOs

public java.util.Map<java.lang.Long,FlagStore> getCreatedBOs(BOLoaderI bol)

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

Parameters:

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

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:

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

getCreatedBOs

public java.util.Map<java.lang.Long,FlagStore> getCreatedBOs(BOLoaderI bol,
                                                             java.lang.Class clazz)

Specified by:

getCreatedBOs in interface DBManBOChangeEventI

getCreatedBOs

public java.util.Map<java.lang.Long,FlagStore> getCreatedBOs(BOLoaderI bol,
                                                             java.lang.Class clazz,
                                                             boolean includeUndeletions)

getBOsAsLazyBOReferences

public 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).

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI bol,
                                                  java.lang.Class clazz)

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI bol,
                                                  java.lang.Class clazz,
                                                  boolean created)

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI bol,
                                                  java.lang.Class clazz,
                                                  boolean created,
                                                  boolean changed)

getBOsAsLazyBOReferences

public LazyBOReference[] getBOsAsLazyBOReferences(BOLoaderI bol,
                                                  java.lang.Class clazz,
                                                  boolean created,
                                                  boolean changed,
                                                  boolean deleted)

getChangedBOs

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

Specified by:

getChangedBOs in interface DBManBOChangeEventI

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

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

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI bol,
                                                             java.lang.Class clazz,
                                                             java.lang.String attrName,
                                                             boolean lazy)

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI bol,
                                                             java.lang.Class clazz,
                                                             java.lang.String attrName,
                                                             boolean lazy,
                                                             boolean warnSlow)

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)

getChangedBOs

public 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. Supports various filters.

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.

lazy - if true, then the resulting BOs are wrapped internally into a SoftReference and allowed for cleanup during memory pressure. Will automatically be reloaded on access. Defaults to false.

warnSlow - if true and attrNames is empty or null, then logs a warning due to slow BT fetch. Defaults to false.

includeDeletions - if true, then deleted BOs are included as well. Defaults to false.

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)

getChangedBOs

public java.util.Map<java.lang.Long,FlagStore> getChangedBOs(BOLoaderI bol,
                                                             java.lang.Class clazz,
                                                             java.lang.String[] attrNames,
                                                             boolean lazy,
                                                             boolean warnSlow)

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)

getChangedBOIds

public 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.

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)

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

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)

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

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)

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

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)

Loads and returns the changed BOs of this event.

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[] clazzes,
                             short bOFlag)

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

Parameters:

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

clazzes - filters the BOs, so that only these types are returned

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.

getBOs

public java.util.List getBOs(BOLoaderI bol,
                             java.lang.Class clazz,
                             short bOFlag)

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

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.

addServerSideCalculatedInformation

public void addServerSideCalculatedInformation(DBManEventFilter f)

Description copied from class: DBManEvent

adds any server-side calculated information being calculated using the passed DBManEventFilter, stored in the map serverSideCalculatedInformation using DBManEventFilter.toString() as key

Overrides:

addServerSideCalculatedInformation in class DBManEvent

getServerSideCalculatedInformationForClass

public java.lang.Object[] getServerSideCalculatedInformationForClass(java.lang.Class clazz,
                                                                     DBManEventFilter f)

getServerSideCalculatedInformationForClasses

public java.lang.Object[] getServerSideCalculatedInformationForClasses(java.lang.Class[] clazzes,
                                                                       DBManEventFilter f)

markForTrimming

public 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

getRelevantIndices

public int[] getRelevantIndices(DBManEventFilter f)

returns an int-array containing all indices at which actually requested, i.e. fitting, objects are found in this event

trim

public 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

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 DBManEvent

wasChanged

public boolean wasChanged(int i)

wasCreated

public boolean wasCreated(int i)

wasDeleted

public boolean wasDeleted(int i)

wasUndeleted

public boolean wasUndeleted(int i)

getOldValue

public java.util.Optional<java.lang.Object> getOldValue(BOLoaderI bol,
                                                        java.lang.Long id,
                                                        AttributeI attr,
                                                        java.lang.Object explicitNullValue)

Fetches the old value of the given BO and Attribute from the provided event. Will return an empty optional if this event does not change the given BO and attribute, meaning the current value should've remained unmodified during this event. Optionally handles indirect changes as well.

Parameters:

bol -

event - the event to determine the oldvalue for, nonnull.

id - the bo to determine the oldvalue for, nonnull.

attr - the attribute to look up the old value for, nonnull

explicitNullValue - the value to use in the optional if the BO-attribute is not modified by this BT. null is possible, but not recommended and might result in wrong results if an event contains more than one BT. Suggestion: Use a type that is unsupported by BPs to prevent false positives.

allowIndirectChanges - if true (default), then indirect changes to the given BO are checked as well. Improves detection of whether the attribute has been changed at all. However, the result may be incorrect in certain cases, such as triangular changes. Has no effect for non-relation attributes.

Returns:

the native old value inside an optional, an empty/not-present optional if the attribute did not change in this event.

getOldValue

public java.util.Optional<java.lang.Object> getOldValue(BOLoaderI bol,
                                                        java.lang.Long id,
                                                        AttributeI attr,
                                                        java.lang.Object explicitNullValue,
                                                        boolean allowIndirectChanges)