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:

Cloneable, Comparable<IdAble>, ExternalIdAble, IdAble, 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

Constructor Summary

Constructors

Constructor	Description
TimePeriodImpl(TimePeriodImpl timePeriodImpl)	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	clone()	Create a shallow copy of this entity
String	getDescription()	Return the description
long	getDurationSeconds()	Return the duration in seconds
long	getStartTimeSeconds()	Return the start time
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

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

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

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId

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

compareTo, getId, idEquals, idHashCode

Constructor Detail

TimePeriodImpl

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

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

Throws:

PlanItException - thrown if error

TimePeriodImpl

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

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

Throws:

PlanItException - thrown if error

TimePeriodImpl

public TimePeriodImpl(TimePeriodImpl timePeriodImpl)

Copy constructor

Parameters:

timePeriodImpl - to copy

Method Detail

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

clone

public TimePeriodImpl clone()

Create a shallow copy of this entity

Specified by:

clone in interface IdAble

Overrides:

clone in class ExternalIdAbleImpl

Returns:

shallow 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