de.ipcon.db.core

Class GrooqlBOMaske

java.lang.Object

de.ipcon.db.core.Transliterator

de.ipcon.db.core.Synchable

de.ipcon.db.core.BO

de.ipcon.db.core.CoreBOBase

de.ipcon.db.core.CoreBO

de.ipcon.db.core.BenanntBase

de.ipcon.db.core.Benannt

de.ipcon.db.core.BOMaskeBase

de.ipcon.db.core.BOMaske

de.ipcon.db.core.GrooqlBOMaskeBase

de.ipcon.db.core.GrooqlBOMaske

All Implemented Interfaces:

LazyDataProviderI, NotificationAttachmentI, SaveAwareI, SaveVetoI, TransliteratorI, XMLExportableI, BOFilterI, BOI, DescribableI, Identifiable, SchemaProviderI, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class GrooqlBOMaske
extends de.ipcon.db.core.GrooqlBOMaskeBase
implements BOFilterI

BOMaske subclass that additionally uses a GrooqlFilter to check if given objects match. This allows for (more) efficient querying of the set of fitting objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class de.ipcon.db.core.GrooqlBOMaskeBase

ATT_GrooqlScript, ENT_GrooqlBOMaske

Fields inherited from class de.ipcon.db.core.BOMaskeBase

ATT_Attribut, ATT_AttributBX, ATT_BOAssociatedAlarms, ATT_Entitaet, ATT_Script, ATT_Tid, ATT_VerfuegbareAttribute, ATT_Zuweisungen, ENT_BOMaske

Fields inherited from class de.ipcon.db.core.BenanntBase

ATT_Beschreibung, ATT_KinderRefs, ATT_L10nBeschreibung, ATT_L10nName, ATT_Name, ENT_Benannt

Fields inherited from class de.ipcon.db.core.CoreBOBase

ATT_AlsAntwortAnBeiAuftraegen, ATT_AlsEmpfaengerBCCBeiAuftraegen, ATT_AlsEmpfaengerBeiAuftraegen, ATT_AlsEmpfaengerCCBeiAuftraegen, ATT_AlsKontextBOBeiAuftraegen, ATT_WirdAlsAntwortAnVerwendetBeiAlarmen, ATT_WirdBenachrichtigtBCCBeiAlarm, ATT_WirdBenachrichtigtBeiAlarm, ATT_WirdBenachrichtigtCCBeiAlarm, ENT_CoreBO

Fields inherited from class de.ipcon.db.core.BO

BLOB_KEY, CANCEL_RECALC_CALLED, D_0, D_1, D_10, D_100, D_1000, D_10000, D_5, D_MINUS_1, D_MINUS_ONE, D_ONE, D_ZERO, doExWriteLRMFunction, EMPTY_ARRAY, F_0, F_1, L_0, L10N_KEY_BO_INSTANTIATION, L10N_KEY_BO_WITH_PROTECTED_CONSTRUCTOR, NULL_AGGREGATE, NULL_ITERATOR

Fields inherited from interface de.ipcon.schema.BOI

ATT_Badge, ATT_Badge2, ATT_Badge3, ATT_Badge4, ATT_BLOBCreatedBy, ATT_BLOBCreatedOn, ATT_BLOBDeletedBy, ATT_BLOBDeletedOn, ATT_BLOBLastModifiedBy, ATT_BLOBLastModifiedOn, ATT_Bot, ATT_Crea, ATT_CreatedBy, ATT_CreatedModifiedText, ATT_Id, ATT_InvolvedInProcs, ATT_LastModifiedBy, ATT_Ldel, ATT_Lmod, ATT_Procs, EMPTY_ARRAY, ENT_BO

Constructor Summary

Constructors

Constructor and Description
GrooqlBOMaske()

Method Summary

Modifier and Type	Method and Description
static GrooqlBOMaske	adjustOrCreateInstance(Transaction tx, java.lang.Class<? extends BOI> clazz, java.lang.String name, java.lang.String descr) Factory method that creates a new Grooql-Mask with the passed parameters or returns an existing one, if a mask with the passed name already exists.
static GrooqlBOMaske	adjustOrCreateInstance(Transaction tx, java.lang.Class<? extends BOI> clazz, java.lang.String name, java.lang.String descr, java.lang.String grooqlScript)
static GrooqlBOMaske	adjustOrCreateInstance(Transaction tx, java.lang.Class<? extends BOI> clazz, java.lang.String name, java.lang.String descr, java.lang.String grooqlScript, java.lang.String script)
boolean	changeMayAffectBOSet(BOProcI bpi) Determines if the given BOProcI represents a change that may alter the set of BOs that this BOMaske represents.
boolean	fits(BOI bo)
boolean	fits(BOI bo, java.lang.String attributeName)
boolean	fits(BOI bo, java.lang.String attributeName, boolean errorValueForFailedScript)
void	init(SchemaI schema, Benutzer user)
boolean	mightFilterDependingOnBOInstance()
long	upperCount() Gets the maximum number of BOs in the DB that may match this mask.
long	upperCount(BOLoaderI bol)

Methods inherited from class de.ipcon.db.core.GrooqlBOMaskeBase

copyFrom, copyFrom, equalPayload, getGrooqlScript, getGrooqlScriptNE, getGrooqlScriptNN, getGrooqlScriptNN, needGrooqlScript, readExternal, setBOLoader, setGrooqlScript, slim, slim, writeExternal

Methods inherited from class de.ipcon.db.core.BOMaske

adjustOrCreateInstance, adjustOrCreateInstance, afterVerifyOnServer, byName, byTid, count, count, fits, fits, fits, fits, fits, getAttributBX, getBOClass, getEntityFromEntitaet, getLeastEffortBOMaskeComparator, getLeastEffortRechteZuweisungComparator, getVerfuegbareAttribute, initEnvironment, initEnvironment, isInitialized, parseAttributeString, parseAttributeString, query, query, query, query, query, queryBO, queryBO, queryBO, setAttribut, setAttributBX, setScript, toString, verifyOnClient, verifyOnServer

Methods inherited from class de.ipcon.db.core.BOMaskeBase

addBOAssociatedAlarm, addZuweisung, getAttribut, getAttributNE, getAttributNN, getAttributNN, getBOAssociatedAlarms, getBOAssociatedAlarmsIterator, getEntitaet, getScript, getScriptNE, getScriptNN, getScriptNN, getTid, getTidNE, getTidNN, getTidNN, getVerfuegbareAttributeIterator, getZuweisungen, getZuweisungenIterator, needAttribut, needAttributBX, needEntitaet, needPopulatedBOAssociatedAlarms, needPopulatedVerfuegbareAttribute, needPopulatedZuweisungen, needScript, needTid, pgetBOAssociatedAlarmsLazy, pgetZuweisungenLazy, removeBOAssociatedAlarm, removeZuweisung, setBOAssociatedAlarms, setEntitaet, setTid, setZuweisungen

Methods inherited from class de.ipcon.db.core.Benannt

compareTo, createTID, createTID, getL10nBeschreibung, getL10nName, getPairStorage, inputAsBenanntRelation, inputAsBenanntRelation, inputAsBenanntRelation, inputAsBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiBenanntRelation, inputAsMultiRelation, inputAsMultiRelation, inputAsMultiRelation, inputAsRelation, inputAsRelation, inputAsRelation, inputAsRelation, outputAsBenanntRelation, outputAsBenanntRelation, outputAsMultiBenanntRelation, outputAsMultiBenanntRelation, outputAsMultiRelation, outputAsMultiRelation, outputAsRelation, outputAsRelation, outputAsRelation, outputBOTName, outputIntoElement, outputIntoElement, storePreparedRelationQueryResult

Methods inherited from class de.ipcon.db.core.BenanntBase

addKinderRef, getBeschreibung, getBeschreibungNE, getBeschreibungNN, getBeschreibungNN, getKinderRefs, getKinderRefsIterator, getL10nBeschreibungNE, getL10nBeschreibungNN, getL10nBeschreibungNN, getL10nNameNE, getL10nNameNN, getL10nNameNN, getName, getNameNE, getNameNN, getNameNN, needBeschreibung, needL10nBeschreibung, needL10nName, needName, needPopulatedKinderRefs, pgetKinderRefsLazy, removeKinderRef, setBeschreibung, setKinderRefs, setName

Methods inherited from class de.ipcon.db.core.CoreBOBase

addAlsAntwortAnBeiAuftrag, addAlsEmpfaengerBCCBeiAuftrag, addAlsEmpfaengerBeiAuftrag, addAlsEmpfaengerCCBeiAuftrag, addAlsKontextBOBeiAuftrag, addWirdAlsAntwortAnVerwendetBeiAlarm, addWirdBenachrichtigtBCCBeiAlarm, addWirdBenachrichtigtBeiAlarm, addWirdBenachrichtigtCCBeiAlarm, getAlsAntwortAnBeiAuftraegen, getAlsAntwortAnBeiAuftraegenIterator, getAlsEmpfaengerBCCBeiAuftraegen, getAlsEmpfaengerBCCBeiAuftraegenIterator, getAlsEmpfaengerBeiAuftraegen, getAlsEmpfaengerBeiAuftraegenIterator, getAlsEmpfaengerCCBeiAuftraegen, getAlsEmpfaengerCCBeiAuftraegenIterator, getAlsKontextBOBeiAuftraegen, getAlsKontextBOBeiAuftraegenIterator, getWirdAlsAntwortAnVerwendetBeiAlarmen, getWirdAlsAntwortAnVerwendetBeiAlarmenIterator, getWirdBenachrichtigtBCCBeiAlarm, getWirdBenachrichtigtBCCBeiAlarmIterator, getWirdBenachrichtigtBeiAlarm, getWirdBenachrichtigtBeiAlarmIterator, getWirdBenachrichtigtCCBeiAlarm, getWirdBenachrichtigtCCBeiAlarmIterator, needPopulatedAlsAntwortAnBeiAuftraegen, needPopulatedAlsEmpfaengerBCCBeiAuftraegen, needPopulatedAlsEmpfaengerBeiAuftraegen, needPopulatedAlsEmpfaengerCCBeiAuftraegen, needPopulatedAlsKontextBOBeiAuftraegen, needPopulatedWirdAlsAntwortAnVerwendetBeiAlarmen, needPopulatedWirdBenachrichtigtBCCBeiAlarm, needPopulatedWirdBenachrichtigtBeiAlarm, needPopulatedWirdBenachrichtigtCCBeiAlarm, pgetAlsAntwortAnBeiAuftraegenLazy, pgetAlsEmpfaengerBCCBeiAuftraegenLazy, pgetAlsEmpfaengerBeiAuftraegenLazy, pgetAlsEmpfaengerCCBeiAuftraegenLazy, pgetAlsKontextBOBeiAuftraegenLazy, pgetWirdAlsAntwortAnVerwendetBeiAlarmenLazy, pgetWirdBenachrichtigtBCCBeiAlarmLazy, pgetWirdBenachrichtigtBeiAlarmLazy, pgetWirdBenachrichtigtCCBeiAlarmLazy, removeAlsAntwortAnBeiAuftrag, removeAlsEmpfaengerBCCBeiAuftrag, removeAlsEmpfaengerBeiAuftrag, removeAlsEmpfaengerCCBeiAuftrag, removeAlsKontextBOBeiAuftrag, removeWirdAlsAntwortAnVerwendetBeiAlarm, removeWirdBenachrichtigtBCCBeiAlarm, removeWirdBenachrichtigtBeiAlarm, removeWirdBenachrichtigtCCBeiAlarm, setAlsAntwortAnBeiAuftraegen, setAlsEmpfaengerBCCBeiAuftraegen, setAlsEmpfaengerBeiAuftraegen, setAlsEmpfaengerCCBeiAuftraegen, setAlsKontextBOBeiAuftraegen, setWirdAlsAntwortAnVerwendetBeiAlarmen, setWirdBenachrichtigtBCCBeiAlarm, setWirdBenachrichtigtBeiAlarm, setWirdBenachrichtigtCCBeiAlarm

Methods inherited from class de.ipcon.db.core.BO

_set, $, $, $, $$, $$bo, $$o, $$r, $$ri, $$ri, acquireTxWriteLock, add, afterSaveOnClient, afterSaveOnServer, afterVerifyOnClient, aggregate, aggregate, aggregate, badge, badge, beforeVerifyOnClient, beforeVerifyOnServer, bumpVersion, cacheLocally, cacheLocally, cacheLocallyAndThrowUnwrappedCause, cacheLocallyAndThrowUnwrappedCause, cacheLocallyAndThrowUnwrappedUncheckedCause, cacheLocallyAndThrowUnwrappedUncheckedCause, cancelCheckConstraints, cancelRecalc, cancelRecalcViaLoadingTransaction, clone, commitTransaction, computeTransientPropertyIfAbsent, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, consumeAndAssureTransientPropertyExists, copyBLOBFrom, createCopy, createCopy, deepClone, deepClone, delete, describe, describe, describe, describe, describe, describe, describe, describe, describe, describe, describeId, describeId, describeId, describeId, describeId, describeId, describeId, describeId, describeNE, describeNE, describeNE, describeNE, describeNE, destub, equalPayload, equalPayload, equalPayload, equalPayload, equals, equalsBO, equalsBO, equalsRegardingAttrs, exportBLOB, exReadString, exWriteString, filterDeleted, filterDeleted, filterDeleted, forgetTransientBLOBHandle, frap, getAsBOInIssueReports, getAsBOInIssueReportsIterator, getAsString, getBackendBOLoaderWithPersistenceHandler, getBadge, getBadge, getBadge2, getBadge3, getBadge4, getBLOB, getBLOB, getBLOB, getBLOB, getBLOB, getBLOBAsDataInput, getBLOBAsEncodedString, getBLOBAsEncodedString, getBLOBAsInputStream, getBLOBAsUTF8EncodedString, getBLOBCreatedBy, getBLOBCreatedOn, getBLOBDeletedBy, getBLOBDeletedOn, getBLOBInfo, getBLOBLastModifiedBy, getBLOBLastModifiedOn, getBOLoader, getBot, getBOVersion, getBytes, getCache, getCache, getCache, getCacheNT, getCacheNT, getCacheNT, getCacheProvider, getCacheProvider, getClazz, getCreatedBy, getCreatedModifiedText, getDefaultScriptImportsList, getDefaultScriptImportsList, getDefaultScriptImportsList, getDescribingBOWrapper, getDescribingBOWrapper, getEventProvider, getEventProvider, getId, getInvolvedInProcs, getInvolvedInProcsIterator, getLastModifiedBy, getLazyData, getLoadingTransaction, getNullIterator, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getOrCreate, getPermissionHandler, getProcs, getProcsIterator, getRootLoaderSchema, getSchema, getSizeFast, getTransaction, getTransientProperty, getTransientProperty, getWrappedTransientProperty, hasActiveTransaction, hasBLOB, hasBLOBOnServerSide, hasBOAssignedTempId, hashCode, hasRelationObjects, hasRelationObjects, hasSessionAssignedTempId, hasTempId, hasTempIdForNewBOs, hasTransientProperty, hasTransientPropertyUnfiltered, includeAllowed, includeInTransaction, invalidateBLOBCache, isBOAssignedTempId, isCompoundChangeInProgress, isCurrentTransactionUnderAdminControl, isIgnoreModificationConstraints, isMandatory, isNew, isReadOnly, isServerSideAndLoadedReadOnly, isSessionAssignedTempId, isStub, isTempId, isTempIdForNewInstance, isTemporary, isVisible, isWriteable, markCompoundChangeInProgress, markDelete, markUndelete, needLoadingTransaction, needsReload, needTransactionInclusion, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, nextTempId, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBus, notifyMessageBusOfAdd, notifyMessageBusOfRemove, nullSafeCompareTo, nullSafeCompareTo, nullSafeContainsBO, nullSafeContainsBO, nullSafeEquals, nullSafeEqualsBO, nullSafeEqualsBO, ofStub, propertyMissing, propertyMissing, releaseCompoundChangeInProgress, releaseTxWriteLock, remove, removeBLOB, requireNonEmptyRelation, requireNonNullAttribute, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, requireNonNullAttributes, setAsString, setBadge, setBadge, setBadge2, setBadge3, setBadge4, setBOLoaderNoCascade, setBOLoaderNoCascade, setBot, setId, setId, setIgnoreModificationConstraints, setLazyData, setTempId, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, setTransientProperty, slim, slim, storeBLOB, storeBLOB, storeBLOB, storeBLOB, storeBLOB, stub, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toMap, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, toRelationMapRO, undelete, wrapIfGroovy

Methods inherited from class de.ipcon.db.core.Synchable

getCrea, getLdel, getLmod, isDeleted, isLdel, setCrea, setLdel, setLdel, setLmod

Methods inherited from class de.ipcon.db.core.Transliterator

getInstanceSpecificLocale, getInstanceSpecificPaths, l10n, l10n, l10n, l10n, l10n, l10n, l10n

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.schema.BOI

bumpVersion, cancelCheckConstraints, consumeAndAssureTransientPropertyExists, contains, equalsBO, equalsBO, getAttribute, getAttribute, getBLOB, getBLOB, getBOVersion, getClazz, getCrea, getEntity, getEntity, getRootLoaderSchema, getSchema, getTransientProperty, hasBLOB, hasTransientProperty, hasTransientPropertyUnfiltered, isDeleted, isMandatory, isNew, isReadOnly, isSubEntityOf, isSubEntityOf, isTemporary, isVisible, setTransientProperty, toRelationMapRO

Methods inherited from interface de.ipcon.schema.Identifiable

collectIds, collectIds, getCommaSeparatedIdList, getId, toMap, toMap

Methods inherited from interface de.ipcon.schema.DescribableI

collectDescribe, collectDescribe, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, conciseDesc, describe, describe, describe, describe, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeAndConciseDesc, describeNE, describeNE, join, join, join, notEmptyDescription

Constructor Detail

GrooqlBOMaske

public GrooqlBOMaske()

Method Detail

mightFilterDependingOnBOInstance

public boolean mightFilterDependingOnBOInstance()

Overrides:

mightFilterDependingOnBOInstance in class BOMaske

fits

public boolean fits(BOI bo)

Specified by:

fits in interface BOFilterI

Overrides:

fits in class BOMaske

fits

public boolean fits(BOI bo,
                    java.lang.String attributeName)

Overrides:

fits in class BOMaske

fits

public boolean fits(BOI bo,
                    java.lang.String attributeName,
                    boolean errorValueForFailedScript)

Overrides:

fits in class BOMaske

init

public void init(SchemaI schema,
                 Benutzer user)

Overrides:

init in class BOMaske

adjustOrCreateInstance

public static GrooqlBOMaske adjustOrCreateInstance(Transaction tx,
                                                   java.lang.Class<? extends BOI> clazz,
                                                   java.lang.String name,
                                                   java.lang.String descr)

Factory method that creates a new Grooql-Mask with the passed parameters or returns an existing one, if a mask with the passed name already exists. An existing instance's entity and script are adjusted according to the passed parameters.

Parameters:

tx - the Transaction

clazz - the Class of BOs to be surveyed / for the Grooql-mask

name - the name of the mask

descr - the description of the mask

script - an optional script

grooqlScript - an optional grooql script // FIXME the mask's attribute could also be passed here!

Returns:

the new, initialized class or an existing one with the same name.

adjustOrCreateInstance

public static GrooqlBOMaske adjustOrCreateInstance(Transaction tx,
                                                   java.lang.Class<? extends BOI> clazz,
                                                   java.lang.String name,
                                                   java.lang.String descr,
                                                   java.lang.String grooqlScript)

adjustOrCreateInstance

public static GrooqlBOMaske adjustOrCreateInstance(Transaction tx,
                                                   java.lang.Class<? extends BOI> clazz,
                                                   java.lang.String name,
                                                   java.lang.String descr,
                                                   java.lang.String grooqlScript,
                                                   java.lang.String script)

changeMayAffectBOSet

public boolean changeMayAffectBOSet(BOProcI bpi)

Description copied from class: BOMaske

Determines if the given BOProcI represents a change that may alter the set of BOs that this BOMaske represents. FIXME! TT 2022-11-23: Actually, the method currently _could_ be "static". But in the future, there might be cases where the result *is* dependent on the actual instance; thus, they are implemented as instance methods.

Overrides:

changeMayAffectBOSet in class BOMaske

Parameters:

bpi - the BOProcI representing the change

Returns:

true if the given BOProcI represents a change that may alter the set of BOs this BOMaske represents; false otherwise

upperCount

public long upperCount()

Description copied from class: BOMaske

Gets the maximum number of BOs in the DB that may match this mask. Currently this only queries the total number of objects of this mask's entity, so it is accurate (same as count) if no script is defined - mightFilterDependingOnBOInstance() == false - but may be vastly too high if this mask has a script.

Overrides:

upperCount in class BOMaske

Returns:

the maximum number of BOs in the DB that may match this mask

upperCount

public long upperCount(BOLoaderI bol)

Overrides:

upperCount in class BOMaske