org.atlasapi.schedule

Class AbstractScheduleStore

java.lang.Object

org.atlasapi.schedule.AbstractScheduleStore

All Implemented Interfaces:

ScheduleResolver, ScheduleStore, ScheduleWriter

public abstract class AbstractScheduleStore
extends Object
implements ScheduleStore

AbstractScheduleStore is a base implementation of a ScheduleStore. It first checks the integrity of the provided ScheduleHierarchys, persists all Content to the ContentStore and then resolves and updates schedule as necessary. Schedules are divided into discrete, contiguous blocks of regular duration, represented by ChannelSchedules. The block duration is determined by the concrete implementation. Blocks may be empty, partially populated or fully populated. Blocks may also have entries in common if they overlap the start or end of the block interval. This base will also detect overwritten Broadcasts and update them in the ContentStore.

Constructor Summary

Constructors

Constructor and Description
AbstractScheduleStore(ContentStore contentStore)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doWrite(org.atlasapi.media.entity.Publisher source, List<ChannelSchedule> blocks) Write the blocks of schedule for a source.
protected abstract List<ChannelSchedule>	resolveCurrentScheduleBlocks(org.atlasapi.media.entity.Publisher source, org.atlasapi.media.channel.Channel channel, org.joda.time.Interval interval) Resolve the current block(s) of schedule for a given source, channel and interval.
List<WriteResult<? extends Content>>	writeSchedule(List<ScheduleHierarchy> content, org.atlasapi.media.channel.Channel channel, org.joda.time.Interval interval) Write a schedule of Items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.atlasapi.schedule.ScheduleResolver

resolve

Constructor Detail

AbstractScheduleStore

public AbstractScheduleStore(ContentStore contentStore)

Method Detail

writeSchedule

public List<WriteResult<? extends Content>> writeSchedule(List<ScheduleHierarchy> content,
                                                 org.atlasapi.media.channel.Channel channel,
                                                 org.joda.time.Interval interval)
                                                   throws WriteException

Description copied from interface: ScheduleWriter

Write a schedule of Items. The Items are presented in a hierarchy along with their Containers. Each Item must have a Broadcast on the provided Channel within the provided Interval. The Hierarchies must be ordered such that the relevant Broadcasts are contiguous. All the Content must be from the same Source. All Content must be persisted to a ContentStore. A ScheduleWriter is also responsible for maintaining Broadcast "actively published" flag status in the ContentStore.

Specified by:

writeSchedule in interface ScheduleWriter

Parameters:

content - - an list of ScheduleHierarchys ordered by Broadcast transmission start time.

channel - - the channel for which the schedule is to be written.

interval - - the interval for which the schedule is provided.

Returns:

write results for every piece of Content written from the hierarchies.

Throws:

WriteException - if the write is not successfully performed.

resolveCurrentScheduleBlocks

protected abstract List<ChannelSchedule> resolveCurrentScheduleBlocks(org.atlasapi.media.entity.Publisher source,
                                                 org.atlasapi.media.channel.Channel channel,
                                                 org.joda.time.Interval interval)
                                                               throws WriteException

Resolve the current block(s) of schedule for a given source, channel and interval. All the blocks overlapped, fully or partially, by the interval must be returned with all entries fully populated. If there is no data for block then an empty block must be returned.

Parameters:

source -

channel -

interval -

Returns:

Throws:

WriteException

doWrite

protected abstract void doWrite(org.atlasapi.media.entity.Publisher source,
           List<ChannelSchedule> blocks)
                         throws WriteException

Write the blocks of schedule for a source. The entries in the blocks may not necessarily fully populate a block. Entries in a block may overlap the beginning or end of a block. The same entry will be included two or more adjacent blocks if it overlaps their respective ends/beginnings. For example broadcasts A, B, C may be written in blocks as

  |A, B| | B | | B, C|
  

if the broadcast B is long enough to cover more than one entire block.

Parameters:

source -

blocks -

Throws:

WriteException