Package org.goplanit.time

Class TimePeriodImpl

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.id.ExternalIdAbleImpl

org.goplanit.time.TimePeriodImpl

All Implemented Interfaces:

Comparable<IdAble>, ExternalIdAble, IdAble, ManagedId, TimePeriod

public class TimePeriodImpl
extends ExternalIdAbleImpl
implements TimePeriod

Represents a time period within the day. Used to determine the duration and start time of trips for example. We internally adopt seconds as the unit

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.utils.time.TimePeriod

TIMEPERIOD_ID_CLASS

Constructor Summary

Constructors

Constructor	Description
TimePeriodImpl(TimePeriodImpl timePeriodImpl, boolean deepCopy)	Copy constructor
TimePeriodImpl(IdGroupingToken groupId, long startTimeSeconds, long durationSeconds)	Constructor
TimePeriodImpl(IdGroupingToken groupId, String description, long startTimeSeconds, long durationSeconds)	Constructor

Method Summary

Modifier and Type	Method	Description
TimePeriodImpl	deepClone()	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
protected static long	generateId(IdGroupingToken tokenId)	Generate id for instances of this class based on the token and class identifier
String	getDescription()	Return the description
long	getDurationSeconds()	Return the duration in seconds
long	getStartTimeSeconds()	Return the start time
long	recreateManagedIds(IdGroupingToken tokenId)	recreate the internal id(s) and set them including the Idable id
TimePeriodImpl	shallowClone()	Create a shallow copy of this entity
String	toString()	Output this object as a String

Methods inherited from class org.goplanit.utils.id.ExternalIdAbleImpl

getExternalId, getXmlId, setExternalId, setXmlId

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, generateId, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, getId, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.id.ManagedId

resetChildManagedIdEntities

Methods inherited from interface org.goplanit.utils.time.TimePeriod

getDurationHours, getIdClass, hasDescription

Constructor Detail

TimePeriodImpl

public TimePeriodImpl(IdGroupingToken groupId,
                      long startTimeSeconds,
                      long durationSeconds)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

startTimeSeconds - start time in seconds from midnight

durationSeconds - duration in seconds

TimePeriodImpl

public TimePeriodImpl(IdGroupingToken groupId,
                      String description,
                      long startTimeSeconds,
                      long durationSeconds)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

description - description of this time period

startTimeSeconds - start time of this time period

durationSeconds - duration of this time period

TimePeriodImpl

public TimePeriodImpl(TimePeriodImpl timePeriodImpl,
                      boolean deepCopy)

Copy constructor

Parameters:

timePeriodImpl - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

generateId

protected static long generateId(IdGroupingToken tokenId)

Generate id for instances of this class based on the token and class identifier

Parameters:

tokenId - to use

Returns:

generated id

getStartTimeSeconds

public long getStartTimeSeconds()

Return the start time

Specified by:

getStartTimeSeconds in interface TimePeriod

Returns:

start time

getDurationSeconds

public long getDurationSeconds()

Return the duration in seconds

Specified by:

getDurationSeconds in interface TimePeriod

Returns:

duration

getDescription

public String getDescription()

Return the description

Specified by:

getDescription in interface TimePeriod

Returns:

description of this TimePeriod

recreateManagedIds

public long recreateManagedIds(IdGroupingToken tokenId)

recreate the internal id(s) and set them including the Idable id

Specified by:

recreateManagedIds in interface ManagedId

Parameters:

tokenId - to use (may be null in case managed id entity does not rely on token to recreate its managed id(s))

Returns:

the updated internal id

shallowClone

public TimePeriodImpl shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface TimePeriod

Overrides:

shallowClone in class ExternalIdAbleImpl

Returns:

shallow copy of entity

deepClone

public TimePeriodImpl deepClone()

An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in interface TimePeriod

Overrides:

deepClone in class ExternalIdAbleImpl

Returns:

deep copy of entity

toString

public String toString()

Output this object as a String

Overrides:

toString in class Object

Returns:

String containing the value of this TimePeriod