uk.ac.ed.epcc.webapp.model.period

Interface SequenceManager<T extends TimePeriod>

Type Parameters:

T - type of TimePeriod

All Superinterfaces:

SplitManager<T>

public interface SequenceManager<T extends TimePeriod>
extends SplitManager<T>

A SplitManager where the TimePeriods are arranged in ordered sequences. By default these are non-overlapping sequences in time order. Optionally overlapps can be enabled on a sequence by sequence bases in which case the sequence order is roughly time ordered.

Method Summary

Modifier and Type	Method and Description
default void	canChangeEnd(T current, java.util.Date d) Additional validation checks
default void	canChangeStart(T current, java.util.Date d) Additional validation checks
boolean	canMerge(T first, T second) Test to see if two periods can be merged.
default T	getMergeCandidate(T current, boolean move_up) Get the element from the sequence most likely to be merged with the current record
T	getNextInSequence(T current, boolean move_up) Get the next entry in the sequence.
T	merge(T first, T second) Merge two periods
default boolean	noOverlapps(T target) Does the record come from a sequence that disallows overlapping records
void	setEnd(T period, java.util.Date d) Change the end date on the period
void	setStart(T period, java.util.Date d) Change the start date on the period

Methods inherited from interface uk.ac.ed.epcc.webapp.model.period.SplitManager

canSplit, getDateInput, getEditLimit, getEditMarker, split

Method Detail

noOverlapps

default boolean noOverlapps(T target)

Does the record come from a sequence that disallows overlapping records

Parameters:

target -

Returns:

canMerge

boolean canMerge(T first,
                 T second)

Test to see if two periods can be merged. Usually this means test if they are neighbouring periods from the same sequence.

Parameters:

first -

second -

Returns:

boolean

merge

T merge(T first,
        T second)
 throws java.lang.Exception

Merge two periods

Parameters:

first -

second -

Returns:

the merged Period

Throws:

java.lang.Exception

getNextInSequence

T getNextInSequence(T current,
                    boolean move_up)

Get the next entry in the sequence.

Parameters:

current - starting period

move_up - direction of move

Returns:

period or null

getMergeCandidate

default T getMergeCandidate(T current,
                            boolean move_up)

Get the element from the sequence most likely to be merged with the current record

Parameters:

current -

move_up -

Returns:

Merge candidate

canChangeStart

default void canChangeStart(T current,
                            java.util.Date d)
                     throws ValidateException

Additional validation checks

Parameters:

current -

d -

Throws:

ValidateException

canChangeEnd

default void canChangeEnd(T current,
                          java.util.Date d)
                   throws ValidateException

Additional validation checks

Parameters:

current -

d -

Throws:

ValidateException

setStart

void setStart(T period,
              java.util.Date d)
       throws java.lang.Exception

Change the start date on the period

Parameters:

period -

d -

Throws:

java.lang.Exception

setEnd

void setEnd(T period,
            java.util.Date d)
     throws java.lang.Exception

Change the end date on the period

Parameters:

period -

d -

Throws:

java.lang.Exception