Package org.bedework.calfacade

Class BwFilterDef

java.lang.Object

org.bedework.calfacade.base.DumpEntity<T>

org.bedework.calfacade.base.BwUnversionedDbentity<T>

org.bedework.calfacade.base.BwDbentity<T>

org.bedework.calfacade.base.BwOwnedDbentity<T>

org.bedework.calfacade.base.BwShareableDbentity<T>

org.bedework.calfacade.base.BwShareableContainedDbentity<BwFilterDef>

org.bedework.calfacade.BwFilterDef

All Implemented Interfaces:

Serializable, Comparable<BwFilterDef>, Comparator<BwFilterDef>, DescriptionEntity<BwLongString>, DisplayNameEntity, OwnedEntity, ShareableEntity, org.bedework.util.logging.Logged

public class BwFilterDef
extends BwShareableContainedDbentity<BwFilterDef>
implements DescriptionEntity<BwLongString>, DisplayNameEntity, Comparator<BwFilterDef>

A filter selects events (and possibly other entities) that fulfill certain criteria. For example, "All events that have the category 'Lecture'".

All filters must be expressible as a db search expresssion. Entity filters select events that own a given entity or own an entity within a set. This translates to
event.location = given-location or
event.location in given-location-set

The test may be negated to give != and not in.

Some filters can have any number of children such as an OrFilter.

Version:

1.1

Author:

Mike Douglass

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.bedework.calfacade.base.DumpEntity

DumpEntity.DumpType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	maxNameLength

Constructor Summary

Constructors

Constructor	Description
BwFilterDef()

Method Summary

Modifier and Type	Method	Description
void	addDescription(String lang, String val)
void	addDescription(BwLongString val)
void	addDisplayName(String lang, String val)
void	addDisplayName(BwString val)
int	compare(BwFilterDef f1, BwFilterDef f2)
int	compareTo(BwFilterDef that)
BwLongString	findDescription(String lang)
BwString	findDisplayName(String lang)
String	getColPath()	Get the object's collection path
String	getDefinition()	Get the definition
String	getDescription()
Set<BwLongString>	getDescriptions()	Get the descriptions
String	getDisplayName()
Collection<BwString>	getDisplayNames()	Get the display names
org.bedework.caldav.util.filter.FilterBase	getFilters()	Get the filters represented by the definition
String	getHref()
String	getName()	Get the name
int	getNumDescriptions()
int	getNumDisplayNames()
int	hashCode()
boolean	removeDescription(BwLongString val)
boolean	removeDisplayName(BwString val)
void	setDefinition(String val)	Set the definition
void	setDescription(String val)
void	setDescriptions(Set<BwLongString> val)	Set the descriptions Set
void	setDisplayName(String val)
void	setDisplayNames(Collection<BwString> val)	Set the display names collection
void	setFilters(org.bedework.caldav.util.filter.FilterBase val)	Set the filters represented by the definition
void	setName(String val)	Set the name
protected void	toStringSegment(org.bedework.util.misc.ToString ts)	Add our stuff to the StringBuilder
void	updateDescriptions(String lang, String val)	If description with given lang is present updates the value, otherwise adds it.
void	updateDisplayNames(String lang, String val)	If display name with given lang is present updates the value, otherwise adds it.

Methods inherited from class org.bedework.calfacade.base.BwShareableContainedDbentity

copyTo, setColPath, setColPath, shallowCopyTo

Methods inherited from class org.bedework.calfacade.base.BwShareableDbentity

copyTo, getAccess, getCreatorEnt, getCreatorHref, setAccess, setCreatorEnt, setCreatorHref, shallowCopyTo

Methods inherited from class org.bedework.calfacade.base.BwOwnedDbentity

copyTo, getOwnerHref, getPublick, setOwnerHref, setPublick, shallowCopyTo

Methods inherited from class org.bedework.calfacade.base.BwDbentity

addDeletedEntity, afterDeletion, beforeDeletion, beforeSave, beforeUpdate, getByteSize, getDeletedEntities, getSeq, length, setByteSize, setSeq

Methods inherited from class org.bedework.calfacade.base.BwUnversionedDbentity

clone, equals, getId, markUnsaved, setHref, setId, unsaved

Methods inherited from class org.bedework.calfacade.base.DumpEntity

dump, dump, getLogger, hasDumpValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn

Methods inherited from interface org.bedework.calfacade.base.OwnedEntity

getOwnerHref, getPublick, setOwnerHref, setPublick

Field Details

maxNameLength

public static final int maxNameLength

See Also:

• Constant Field Values

Constructor Details

BwFilterDef

public BwFilterDef()

Method Details

setName

public void setName(String val)

Set the name

Parameters:

val - String name

getName

public String getName()

Get the name

Returns:

String name

setFilters

public void setFilters(org.bedework.caldav.util.filter.FilterBase val)

Set the filters represented by the definition

Parameters:

val - BwFilter object

getFilters

public org.bedework.caldav.util.filter.FilterBase getFilters()

Get the filters represented by the definition

Returns:

BwFilter the filters

setDefinition

public void setDefinition(String val)

Set the definition

Parameters:

val - String definition

getDefinition

public String getDefinition()

Get the definition

Returns:

String definition

setDisplayNames

public void setDisplayNames(Collection<BwString> val)

Description copied from interface: DisplayNameEntity

Set the display names collection

Specified by:

setDisplayNames in interface DisplayNameEntity

Parameters:

val - Collection of (BwString)display names

getDisplayNames

public Collection<BwString> getDisplayNames()

Description copied from interface: DisplayNameEntity

Get the display names

Specified by:

getDisplayNames in interface DisplayNameEntity

Returns:

Collection display names set

getNumDisplayNames

public int getNumDisplayNames()

Specified by:

getNumDisplayNames in interface DisplayNameEntity

Returns:

int number of display names.

addDisplayName

public void addDisplayName(String lang,
 String val)

Specified by:

addDisplayName in interface DisplayNameEntity

addDisplayName

public void addDisplayName(BwString val)

Specified by:

addDisplayName in interface DisplayNameEntity

removeDisplayName

public boolean removeDisplayName(BwString val)

Specified by:

removeDisplayName in interface DisplayNameEntity

Returns:

boolean true if removed.

updateDisplayNames

public void updateDisplayNames(String lang,
 String val)

Description copied from interface: DisplayNameEntity

If display name with given lang is present updates the value, otherwise adds it.

Specified by:

updateDisplayNames in interface DisplayNameEntity

findDisplayName

public BwString findDisplayName(String lang)

Specified by:

findDisplayName in interface DisplayNameEntity

Returns:

BwString with language code or default

setDisplayName

public void setDisplayName(String val)

Specified by:

setDisplayName in interface DisplayNameEntity

Parameters:

val - String default

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface DisplayNameEntity

Returns:

String default

setDescriptions

public void setDescriptions(Set<BwLongString> val)

Description copied from interface: DescriptionEntity

Set the descriptions Set

Specified by:

setDescriptions in interface DescriptionEntity<BwLongString>

Parameters:

val - Set of (BwString)descriptions

getDescriptions

public Set<BwLongString> getDescriptions()

Description copied from interface: DescriptionEntity

Get the descriptions

Specified by:

getDescriptions in interface DescriptionEntity<BwLongString>

Returns:

Set descriptions set

getNumDescriptions

public int getNumDescriptions()

Specified by:

getNumDescriptions in interface DescriptionEntity<BwLongString>

Returns:

int number of descriptions.

addDescription

public void addDescription(String lang,
 String val)

Specified by:

addDescription in interface DescriptionEntity<BwLongString>

addDescription

public void addDescription(BwLongString val)

Specified by:

addDescription in interface DescriptionEntity<BwLongString>

removeDescription

public boolean removeDescription(BwLongString val)

Specified by:

removeDescription in interface DescriptionEntity<BwLongString>

Returns:

boolean true if removed.

updateDescriptions

public void updateDescriptions(String lang,
 String val)

Description copied from interface: DescriptionEntity

If description with given lang is present updates the value, otherwise adds it.

Specified by:

updateDescriptions in interface DescriptionEntity<BwLongString>

findDescription

public BwLongString findDescription(String lang)

Specified by:

findDescription in interface DescriptionEntity<BwLongString>

Returns:

BwString with language code or default

setDescription

public void setDescription(String val)

Specified by:

setDescription in interface DescriptionEntity<BwLongString>

Parameters:

val - String default

getDescription

public String getDescription()

Specified by:

getDescription in interface DescriptionEntity<BwLongString>

Returns:

String default

getColPath

public String getColPath()

Description copied from class: BwShareableContainedDbentity

Get the object's collection path

Overrides:

getColPath in class BwShareableContainedDbentity<BwFilterDef>

Returns:

String path

getHref

public String getHref()

Overrides:

getHref in class BwUnversionedDbentity<BwFilterDef>

Returns:

non null unique href for the entity

toStringSegment

protected void toStringSegment(org.bedework.util.misc.ToString ts)

Add our stuff to the StringBuilder

Overrides:

toStringSegment in class BwShareableContainedDbentity<BwFilterDef>

Parameters:

ts - StringBuilder for result

compare

public int compare(BwFilterDef f1,
 BwFilterDef f2)

Specified by:

compare in interface Comparator<BwFilterDef>

compareTo

public int compareTo(BwFilterDef that)

Specified by:

compareTo in interface Comparable<BwFilterDef>

Overrides:

compareTo in class BwUnversionedDbentity<BwFilterDef>

hashCode

public int hashCode()

Overrides:

hashCode in class BwUnversionedDbentity<BwFilterDef>