Package org.bedework.carddav.server.dirHandlers.db

Class DbEntity<T>

java.lang.Object

org.bedework.carddav.server.dirHandlers.db.DumpEntity<T>

org.bedework.carddav.server.dirHandlers.db.UnversionedDbentity<T>

org.bedework.carddav.server.dirHandlers.db.DbEntity<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, Comparable<T>, org.bedework.util.logging.Logged, org.bedework.webdav.servlet.access.SharedEntity

Direct Known Subclasses:

DbNamedEntity

public abstract class DbEntity<T>
extends UnversionedDbentity<T>
implements org.bedework.webdav.servlet.access.SharedEntity

Base type for a database entity. We require an id and the subclasses must implement hashcode and compareTo.

Version:

1.0

Author:

Mike Douglass

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.bedework.carddav.server.dirHandlers.db.DumpEntity

DumpEntity.DumpType

Constructor Summary

Constructors

Constructor	Description
DbEntity()	No-arg constructor

Method Summary

Modifier and Type	Method	Description
void	addDeletedEntity(DbEntity<?> val)	Add a deleted entity - these may appear as a result of updates.
void	afterDeletion()	Called after delete from the db
void	beforeDeletion()	Called when we are about to delete from the db
void	beforeSave()	Called when we are about to save the object.
void	beforeUpdate()	Called when we are about to update the object.
String	getAccess()
int	getByteSize()
String	getCreated()
String	getCreatorHref()
Collection<DbEntity<?>>	getDeletedEntities()
String	getOwnerHref()
String	getParentPath()
Integer	getSeq()	Get the entity seq
int	length()	Size to use for quotas.
void	setAccess(String val)
void	setByteSize(int val)	The last calculated byte size should be stored with the entity.
void	setCreated(String val)
void	setCreatorHref(String val)
void	setOwnerHref(String val)
void	setParentPath(String val)
void	setSeq(Integer val)	Set the seq for this entity
void	toStringSegment(org.bedework.base.ToString ts)	Add our stuff to the ToString builder

Methods inherited from class org.bedework.carddav.server.dirHandlers.db.UnversionedDbentity

clone, compareTo, equals, getId, hashCode, setId, unsaved

Methods inherited from class org.bedework.carddav.server.dirHandlers.db.DumpEntity

dump, dump, getLogger, hasDumpValue

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface org.bedework.webdav.servlet.access.SharedEntity

getAccessState, getPath, isCollection, setAccessState

Constructor Details

DbEntity

public DbEntity()

No-arg constructor

Method Details

setByteSize

public void setByteSize(int val)

The last calculated byte size should be stored with the entity. On update call calculateByteSize to get a new value and use the difference to adjust the quota.

Parameters:

val - byte size

getByteSize

public int getByteSize()

Returns:

int last byte size

setSeq

public void setSeq(Integer val)

Set the seq for this entity

Parameters:

val - int seq

getSeq

public Integer getSeq()

Get the entity seq

Returns:

int the entity seq

setOwnerHref

public void setOwnerHref(String val)

Specified by:

setOwnerHref in interface org.bedework.webdav.servlet.access.SharedEntity

Parameters:

val - owner href

getOwnerHref

public String getOwnerHref()

Specified by:

getOwnerHref in interface org.bedework.webdav.servlet.access.SharedEntity

Returns:

String

setCreatorHref

public void setCreatorHref(String val)

Parameters:

val - creatorHref

getCreatorHref

public String getCreatorHref()

Returns:

String

setAccess

public void setAccess(String val)

Specified by:

setAccess in interface org.bedework.webdav.servlet.access.SharedEntity

Parameters:

val - access

getAccess

public String getAccess()

Specified by:

getAccess in interface org.bedework.webdav.servlet.access.SharedEntity

Returns:

String

setParentPath

public void setParentPath(String val)

Specified by:

setParentPath in interface org.bedework.webdav.servlet.access.SharedEntity

Parameters:

val - parent path

getParentPath

public String getParentPath()

Specified by:

getParentPath in interface org.bedework.webdav.servlet.access.SharedEntity

Returns:

parentPath.

setCreated

public void setCreated(String val)

Parameters:

val - create date/time

getCreated

public String getCreated()

Returns:

String created

addDeletedEntity

public void addDeletedEntity(DbEntity<?> val)

Add a deleted entity - these may appear as a result of updates. A null parameter is a noop.

Parameters:

val - a deleted entity

getDeletedEntities

public Collection<DbEntity<?>> getDeletedEntities()

Returns:

deleted entities or null

beforeDeletion

public void beforeDeletion()

Called when we are about to delete from the db

afterDeletion

public void afterDeletion()

Called after delete from the db

beforeUpdate

public void beforeUpdate()

Called when we are about to update the object.

beforeSave

public void beforeSave()

Called when we are about to save the object. Default to calling before update

length

public int length()

Size to use for quotas.

Returns:

int

toStringSegment

public void toStringSegment(org.bedework.base.ToString ts)

Description copied from class: UnversionedDbentity

Add our stuff to the ToString builder

Overrides:

toStringSegment in class UnversionedDbentity<T>

Parameters:

ts - ToString builder for result