Package org.bedework.calfacade

Class BwXproperty

java.lang.Object

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

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

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

org.bedework.calfacade.BwXproperty

All Implemented Interfaces:

Serializable, Comparable<BwXproperty>, BwCloneable, org.bedework.util.logging.Logged

public class BwXproperty
extends BwDbentity<BwXproperty>
implements BwCloneable

Save xproperty values. In general we cannot process these.

Author:

Mike Douglass

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BwXproperty.Xpar
static class	BwXproperty.XpropInfo

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

DumpEntity.DumpType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	appleDefaultAlarm
static final String	appleNeedsReply
static final String	bedeworkAlias	Path of alias (topical area)
static final String	bedeworkAttendeeSchedulingObject
static final String	bedeworkCalsuite
static final String	bedeworkChanges	Changes made to an event.
static final String	bedeworkCost	Maintain our cost
static final String	bedeworkDavProp	Holds a text DAV property
static final String	bedeworkDeleted	The deleted flag
static final String	bedeworkDisplayName	Display name parameter
static final String	bedeworkEventRegEnd
static final String	bedeworkEventRegExternal
static final String	bedeworkEventRegForm
static final String	bedeworkEventRegInternal
static final String	bedeworkEventRegMaxTickets
static final String	bedeworkEventRegMaxTicketsPerUser
static final String	bedeworkEventRegStart
static final String	bedeworkEventRegWaitListLimit
static final String	bedeworkExsynchEndtzid
static final String	bedeworkExsynchLastmod
static final String	bedeworkExsynchOrganizer
static final String	bedeworkExsynchStarttzid
static final String	bedeworkIcal	Holds a text icalendar value
static final String	bedeworkIcalProp	Holds a text icalendar property - first (or only) parameter is always "PNAME" and its value is the real property name
static final String	bedeworkIcalPropPname	name of that parameter
static final String	bedeworkImage
static final String	bedeworkOrganizerSchedulingObject
static final String	bedeworkParamAliasPath	alias target parameter
static final String	bedeworkParamPath	alias path parameter
static final String	bedeworkParticipant	Holds a participant object
static final String	bedeworkPublishUrl
static final String	bedeworkRelatedTo	Holds an encoded array of related to - until schema gets updated
static final String	bedeworkSchedAssist
static final String	bedeworkSchedulingEntityPath	Path of scheduling object in users calendar collections
static final String	bedeworkSchedulingNew	Set on inbox entity to flag a new meeting
static final String	bedeworkSchedulingReplyUpdate	Set on inbox entity to flag a trivial update (organizer update after attendee reply)
static final String	bedeworkSchedulingReschedule	Set on inbox entity to flag a rescheduled meeting
static final String	bedeworkSubmitAlias	Used only in web submission process
static final String	bedeworkSubmitComment	Used only in web submission process
static final String	bedeworkSubmitStatus	Used only in web submission process
static final String	bedeworkSubmitterClaimant
static final String	bedeworkSubmitterEmail	Used only in web submission process
static final String	bedeworkSuggestedTo	Hold state and href of group in the form state:href where: state = "A" - accepted, "R" - rejected, "P" - pending
static final String	bedeworkTag
static final String	bedeworkThumbImage
static final String	bedeworkTimezonePrefix	Deprecated.
static final String	bedeworkXTimezone	Used to save a timezone - to avoid having to parse the tz spec we prepend the value with the semicolon escaped tzid
static final String	estimatedDuration
static final String	peruserInstance	Flags instances which only exist for peruser data.
static final String	peruserOwnerParam
static final String	peruserPropTransp
static final String	pollAccceptResponse
static final String	pollCandidate
static final String	pollItem
static final String	pollItemId
static final String	pollMode
static final String	pollProperties
static final String	pollVoter
static final String	pollWinner
static final String	xBedeworkCategories
static final String	xBedeworkContact
static final String	xBedeworkLocation
static final String	xBedeworkLocationAccessible
static final String	xBedeworkLocationAddr
static final String	xBedeworkLocationCity
static final String	xBedeworkLocationGeo
static final String	xBedeworkLocationKeyName
static final String	xBedeworkLocationLink
static final String	xBedeworkLocationRoom
static final String	xBedeworkLocationSfield1
static final String	xBedeworkLocationSfield2
static final String	xBedeworkLocationState
static final String	xBedeworkLocationStreet
static final String	xBedeworkLocationZip
static final String	xBedeworkVLocation
static final String	xparUid	Used for location, etc

Constructor Summary

Constructors

Constructor	Description
BwXproperty()	Constructor
BwXproperty(String name, String pars, String value)	Create an x-property by specifying all its fields

Method Summary

Modifier and Type	Method	Description
Object	clone()	Make visible
int	compareTo(BwXproperty that)
static String	escapeName(String val)	Replace space with underscore.
static String	escapeSemi(String val)	Replace semicolon with escape semicolon.
static String	getBwFromJsCal(String jscalName)
String	getName()	Get the name
String	getParam(String name)
List<BwXproperty.Xpar>	getParameters()
String	getPars()	Get the pars
boolean	getSkip()
boolean	getSkipJsp()
String	getValue()	Get the value
static BwXproperty.XpropInfo	getXpropInfo(String name)
int	hashCode()
static void	main(String[] args)
static BwXproperty	makeBwAlias(String displayName, String aliasUri, String aliasPath, String topicalAreaPath)	Make an xproperty to hold a bedework alias
static BwXproperty	makeDavProperty(String name, String value)	Make an xproperty to hold a dav property
static BwXproperty	makeIcalProperty(String name, String pars, String value)	Make an xproperty to hold an unknown ical property
static int	nextSemi(String val, int start)	Return the position of the next unescaped semicolon
static List<BwXproperty.Xpar>	parseParameters(String val)
void	setName(String val)	Set the name
void	setPars(String val)	Set the pars
void	setValue(String val)	Set the value
String	toString()
protected void	toStringSegment(org.bedework.util.misc.ToString ts)	Add our stuff to the ToString object
static String	unescapeSemi(String val)	Replace escaped semicolon with semicolon.

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

equals, getHref, 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, wait, wait, wait

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

Field Details

bedeworkOrganizerSchedulingObject

public static final String bedeworkOrganizerSchedulingObject

See Also:

• Constant Field Values

bedeworkAttendeeSchedulingObject

public static final String bedeworkAttendeeSchedulingObject

See Also:

• Constant Field Values

bedeworkSubmitComment

public static final String bedeworkSubmitComment

Used only in web submission process

See Also:

• Constant Field Values

bedeworkSubmitStatus

public static final String bedeworkSubmitStatus

Used only in web submission process

See Also:

• Constant Field Values

bedeworkSubmitAlias

public static final String bedeworkSubmitAlias

Used only in web submission process

See Also:

• Constant Field Values

bedeworkSubmitterEmail

public static final String bedeworkSubmitterEmail

Used only in web submission process

See Also:

• Constant Field Values

bedeworkSubmitterClaimant

public static final String bedeworkSubmitterClaimant

See Also:

• Constant Field Values

bedeworkAlias

public static final String bedeworkAlias

Path of alias (topical area)

See Also:

• Constant Field Values

bedeworkDisplayName

public static final String bedeworkDisplayName

Display name parameter

See Also:

• Constant Field Values

bedeworkParamPath

public static final String bedeworkParamPath

alias path parameter

See Also:

• Constant Field Values

bedeworkParamAliasPath

public static final String bedeworkParamAliasPath

alias target parameter

See Also:

• Constant Field Values

bedeworkSchedulingEntityPath

public static final String bedeworkSchedulingEntityPath

Path of scheduling object in users calendar collections

See Also:

• Constant Field Values

bedeworkSchedulingNew

public static final String bedeworkSchedulingNew

Set on inbox entity to flag a new meeting

See Also:

• Constant Field Values

bedeworkSchedulingReschedule

public static final String bedeworkSchedulingReschedule

Set on inbox entity to flag a rescheduled meeting

See Also:

• Constant Field Values

bedeworkSchedulingReplyUpdate

public static final String bedeworkSchedulingReplyUpdate

Set on inbox entity to flag a trivial update (organizer update after attendee reply)

See Also:

• Constant Field Values

bedeworkDavProp

public static final String bedeworkDavProp

Holds a text DAV property

See Also:

• Constant Field Values

bedeworkIcal

public static final String bedeworkIcal

Holds a text icalendar value

See Also:

• Constant Field Values

bedeworkIcalProp

public static final String bedeworkIcalProp

Holds a text icalendar property - first (or only) parameter is always "PNAME" and its value is the real property name

See Also:

• Constant Field Values

bedeworkIcalPropPname

public static final String bedeworkIcalPropPname

name of that parameter

See Also:

• Constant Field Values

xparUid

public static final String xparUid

Used for location, etc

See Also:

• Constant Field Values

bedeworkCost

public static final String bedeworkCost

Maintain our cost

See Also:

• Constant Field Values

bedeworkDeleted

public static final String bedeworkDeleted

The deleted flag

See Also:

• Constant Field Values

bedeworkRelatedTo

public static final String bedeworkRelatedTo

Holds an encoded array of related to - until schema gets updated

See Also:

• Constant Field Values

bedeworkParticipant

public static final String bedeworkParticipant

Holds a participant object

See Also:

• Constant Field Values

bedeworkExsynchEndtzid

public static final String bedeworkExsynchEndtzid

See Also:

• Constant Field Values

bedeworkExsynchLastmod

public static final String bedeworkExsynchLastmod

See Also:

• Constant Field Values

bedeworkExsynchOrganizer

public static final String bedeworkExsynchOrganizer

See Also:

• Constant Field Values

bedeworkExsynchStarttzid

public static final String bedeworkExsynchStarttzid

See Also:

• Constant Field Values

bedeworkSuggestedTo

public static final String bedeworkSuggestedTo

Hold state and href of group in the form state:href where:
state = "A" - accepted, "R" - rejected, "P" - pending

See Also:

• Constant Field Values

bedeworkEventRegMaxTickets

public static final String bedeworkEventRegMaxTickets

See Also:

• Constant Field Values

bedeworkEventRegMaxTicketsPerUser

public static final String bedeworkEventRegMaxTicketsPerUser

See Also:

• Constant Field Values

bedeworkEventRegStart

public static final String bedeworkEventRegStart

See Also:

• Constant Field Values

bedeworkEventRegEnd

public static final String bedeworkEventRegEnd

See Also:

• Constant Field Values

bedeworkEventRegForm

public static final String bedeworkEventRegForm

See Also:

• Constant Field Values

bedeworkEventRegWaitListLimit

public static final String bedeworkEventRegWaitListLimit

See Also:

• Constant Field Values

bedeworkEventRegInternal

public static final String bedeworkEventRegInternal

See Also:

• Constant Field Values

bedeworkEventRegExternal

public static final String bedeworkEventRegExternal

See Also:

• Constant Field Values

bedeworkPublishUrl

public static final String bedeworkPublishUrl

See Also:

• Constant Field Values

peruserPropTransp

public static final String peruserPropTransp

See Also:

• Constant Field Values

peruserOwnerParam

public static final String peruserOwnerParam

See Also:

• Constant Field Values

peruserInstance

public static final String peruserInstance

Flags instances which only exist for peruser data.

See Also:

• Constant Field Values

estimatedDuration

public static final String estimatedDuration

See Also:

• Constant Field Values

pollItemId

public static final String pollItemId

See Also:

• Constant Field Values

pollWinner

public static final String pollWinner

See Also:

• Constant Field Values

pollAccceptResponse

public static final String pollAccceptResponse

See Also:

• Constant Field Values

pollMode

public static final String pollMode

See Also:

• Constant Field Values

pollProperties

public static final String pollProperties

See Also:

• Constant Field Values

pollItem

public static final String pollItem

See Also:

• Constant Field Values

pollVoter

public static final String pollVoter

See Also:

• Constant Field Values

pollCandidate

public static final String pollCandidate

See Also:

• Constant Field Values

xBedeworkCategories

public static final String xBedeworkCategories

See Also:

• Constant Field Values

xBedeworkLocation

public static final String xBedeworkLocation

See Also:

• Constant Field Values

xBedeworkLocationKeyName

public static final String xBedeworkLocationKeyName

See Also:

• Constant Field Values

xBedeworkContact

public static final String xBedeworkContact

See Also:

• Constant Field Values

xBedeworkVLocation

public static final String xBedeworkVLocation

See Also:

• Constant Field Values

xBedeworkLocationAddr

public static final String xBedeworkLocationAddr

See Also:

• Constant Field Values

xBedeworkLocationRoom

public static final String xBedeworkLocationRoom

See Also:

• Constant Field Values

xBedeworkLocationAccessible

public static final String xBedeworkLocationAccessible

See Also:

• Constant Field Values

xBedeworkLocationSfield1

public static final String xBedeworkLocationSfield1

See Also:

• Constant Field Values

xBedeworkLocationSfield2

public static final String xBedeworkLocationSfield2

See Also:

• Constant Field Values

xBedeworkLocationGeo

public static final String xBedeworkLocationGeo

See Also:

• Constant Field Values

xBedeworkLocationStreet

public static final String xBedeworkLocationStreet

See Also:

• Constant Field Values

xBedeworkLocationCity

public static final String xBedeworkLocationCity

See Also:

• Constant Field Values

xBedeworkLocationState

public static final String xBedeworkLocationState

See Also:

• Constant Field Values

xBedeworkLocationZip

public static final String xBedeworkLocationZip

See Also:

• Constant Field Values

xBedeworkLocationLink

public static final String xBedeworkLocationLink

See Also:

• Constant Field Values

bedeworkTag

public static final String bedeworkTag

See Also:

• Constant Field Values

bedeworkCalsuite

public static final String bedeworkCalsuite

See Also:

• Constant Field Values

bedeworkSchedAssist

public static final String bedeworkSchedAssist

See Also:

• Constant Field Values

bedeworkImage

public static final String bedeworkImage

See Also:

• Constant Field Values

bedeworkThumbImage

public static final String bedeworkThumbImage

See Also:

• Constant Field Values

bedeworkXTimezone

public static final String bedeworkXTimezone

Used to save a timezone - to avoid having to parse the tz spec we prepend the value with the semicolon escaped tzid

See Also:

• Constant Field Values

bedeworkTimezonePrefix

@Deprecated
public static final String bedeworkTimezonePrefix

Deprecated.

Pref + name didn't work too well.

See Also:

• Constant Field Values

bedeworkChanges

public static final String bedeworkChanges

Changes made to an event. A semicolon separated list. Elements are

• dtstamp
• action: one of CREATE, UPDATE, CANCEL, REPLY
• MASTER - optional
• RID= - 0 or more
• property name: 0 or more

For example
20100728T16:12:00Z;UPDATE;SUMMARY
20100728T16:12:00Z;UPDATE;MASTER;SUMMARY

See Also:

• Constant Field Values

appleNeedsReply

public static final String appleNeedsReply

See Also:

• Constant Field Values

appleDefaultAlarm

public static final String appleDefaultAlarm

See Also:

• Constant Field Values

Constructor Details

BwXproperty

public BwXproperty()

Constructor

BwXproperty

public BwXproperty(String name,
 String pars,
 String value)

Create an x-property by specifying all its fields

Parameters:

name - String name

pars - String parameters

value - String value

Method Details

getXpropInfo

public static BwXproperty.XpropInfo getXpropInfo(String name)

getBwFromJsCal

public static String getBwFromJsCal(String jscalName)

makeIcalProperty

public static BwXproperty makeIcalProperty(String name,
 String pars,
 String value)

Make an xproperty to hold an unknown ical property

Parameters:

name - - name of the ical property

pars - - ical pars

value - - the property value

Returns:

an xproperty

makeBwAlias

public static BwXproperty makeBwAlias(String displayName,
 String aliasUri,
 String aliasPath,
 String topicalAreaPath)

Make an xproperty to hold a bedework alias

Parameters:

displayName - - topical area display name

aliasUri - - uri without leading "bwcal://"

aliasPath - - target

topicalAreaPath - - path of topical area

Returns:

an xproperty

makeDavProperty

public static BwXproperty makeDavProperty(String name,
 String value)

Make an xproperty to hold a dav property

Parameters:

name - - name of the dav property

value - of property

Returns:

an xproperty

setName

public void setName(String val)

Set the name

Parameters:

val - String name

getName

public String getName()

Get the name

Returns:

String name

setPars

public void setPars(String val)

Set the pars

Parameters:

val - String pars

getPars

public String getPars()

Get the pars

Returns:

String pars

setValue

public void setValue(String val)

Set the value

Parameters:

val - String value

getValue

public String getValue()

Get the value

Returns:

String value

getParameters

public List<BwXproperty.Xpar> getParameters()

Returns:

List of parameters split out at the delimiter

getParam

public String getParam(String name)

Parameters:

name - of parameter

Returns:

Value of named parameter or null

parseParameters

public static List<BwXproperty.Xpar> parseParameters(String val)

Parameters:

val - to parse

Returns:

List

Throws:

RuntimeException - on fatal error

escapeName

public static String escapeName(String val)

Replace space with underscore.

Parameters:

val - to process

Returns:

escaped name

escapeSemi

public static String escapeSemi(String val)

Replace semicolon with escape semicolon.

Parameters:

val - to process

Returns:

escaped name

unescapeSemi

public static String unescapeSemi(String val)

Replace escaped semicolon with semicolon.

Parameters:

val - to process

Returns:

escaped name

nextSemi

public static int nextSemi(String val,
 int start)

Return the position of the next unescaped semicolon

Parameters:

val - to search

start - of search

Returns:

int position of semicolon or -1 for no semicolon

compareTo

public int compareTo(BwXproperty that)

Specified by:

compareTo in interface Comparable<BwXproperty>

Overrides:

compareTo in class BwUnversionedDbentity<BwXproperty>

hashCode

public int hashCode()

Overrides:

hashCode in class BwUnversionedDbentity<BwXproperty>

toStringSegment

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

Description copied from class: BwUnversionedDbentity

Add our stuff to the ToString object

Overrides:

toStringSegment in class BwUnversionedDbentity<BwXproperty>

Parameters:

ts - ToString for result

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Description copied from class: BwUnversionedDbentity

Make visible

Specified by:

clone in interface BwCloneable

Overrides:

clone in class BwUnversionedDbentity<BwXproperty>

Returns:

Object of class T

getSkip

public boolean getSkip()

Returns:

true if this property should be skipped in ical generation

getSkipJsp

public boolean getSkipJsp()

Returns:

true if this property should be skipped in jsp generation

main

public static void main(String[] args)

Parameters:

args - ignored