GROUP_TIMELINES_R0: GROUP_TIMELINES_R0-first.patch

src/main/java/org/sophie2/base/model/book/timelines/Channel.java

@@ +1 @@
+package org.sophie2.base.model.book.timelines;
+
+import org.sophie2.core.prolib.impl.BaseProObject;
+import org.sophie2.core.prolib.interfaces.ListProp;
+
+/**
+ * Represents a timeline channel.
+ * 
+ * @author boyan
+ */
+public class Channel extends BaseProObject {
+
+        /**
+         * The channel entries.
+         * 
+         * @return A list property, holding the entries.
+         */
+        public ListProp<TimelineEntry> entries() {
+                // TODO Auto-generated method stub
+                return null;
+        }
+
+        /**
+         * Adds an entry to the channel.
+         * 
+         * @param timelineEntry
+         *            the entry to be added.
+         */
+        public void addEntry(TimelineEntry timelineEntry) {
+                // TODO Auto-generated method stub
+
+        }
+
+        /**
+         * Removes an entry from the channel.
+         * 
+         * @param timelineEntry
+         *            the entry to be removed
+         */
+        public void removeEntry(TimelineEntry timelineEntry) {
+                // TODO Auto-generated method stub
+
+        }
+}

src/main/java/org/sophie2/base/model/book/timelines/Timeline.java

@@ +1 @@
+package org.sophie2.base.model.book.timelines;
+
+import org.sophie2.base.model.book.Page;
+import org.sophie2.core.prolib.impl.BaseProObject;
+import org.sophie2.core.prolib.interfaces.ListProp;
+import org.sophie2.core.prolib.interfaces.Prop;
+
+/**
+ * Represents a Sophie2 timeline.
+ * 
+ * @author boyan
+ */
+public class Timeline extends BaseProObject {
+
+        /**
+         * Constructs a timeline for a given page with a default duration.
+         * 
+         * @param page
+         *            the page this timeline corresponds to.
+         */
+        public Timeline(Page page) {
+                // nothing for now
+        }
+
+        /**
+         * Constructs a timeline for a given page with a given length.
+         * 
+         * @param page
+         *            the page this timeline corresponds to.
+         * @param duration
+         *            the length of the timeline in seconds
+         */
+        public Timeline(Page page, int duration) {
+                // nothing for now
+        }
+
+        /**
+         * The channels of this timeline. Each channel corresponds to a group of
+         * elements on the page.
+         * 
+         * @return the list property
+         */
+        public ListProp<Channel> channels() {
+                // TODO Auto-generated method stub
+                return null;
+        }
+
+        /**
+         * Moves the head position to a specified time in the timeline. If it
+         * exceeds the length of the timeline, the position is not changed.
+         * 
+         * @param time
+         *            the time to jump to (in seconds).
+         * @return the new head position.
+         */
+        public int jumpTo(int time) {
+                // TODO Auto-generated method stub
+                return 0;
+        }
+
+        /**
+         * The position of the timeline head in seconds.
+         * 
+         * @return a property holding the head position
+         */
+        public Prop<Integer> headPosition() {
+                // TODO Auto-generated method stub
+                return null;
+        }
+
+        /**
+         * Indicates whether the timeline is currently playing.
+         * 
+         * @return a property, holding a boolean value.
+         */
+        public Prop<Boolean> playing() {
+                // TODO Auto-generated method stub
+                return null;
+        }
+
+        /**
+         * Plays the timeline.
+         */
+        public void play() {
+                // TODO Auto-generated method stub
+
+        }
+
+        /**
+         * Pauses the timeline and keeps the head position to resume playing.
+         */
+        public void pause() {
+                // TODO Auto-generated method stub
+
+        }
+
+        /**
+         * Stops the timeline and resets its head position.
+         */
+        public void stop() {
+                // TODO Auto-generated method stub
+
+        }
+}

src/main/java/org/sophie2/base/model/book/timelines/TimelineEntry.java

@@ +1 @@
+package org.sophie2.base.model.book.timelines;
+
+import org.sophie2.base.model.book.PageElement;
+import org.sophie2.core.prolib.impl.BaseProObject;
+
+/**
+ * Represents a timeline entry.
+ * 
+ * @author boyan
+ */
+public class TimelineEntry extends BaseProObject {
+
+        /**
+         * Constructs a timeline entry by a given element (or group of elements) on
+         * the page.
+         * 
+         * @param element
+         */
+        public TimelineEntry(PageElement element) {
+                // TODO Auto-generated constructor stub
+        }
+}

src/test/java/org/sophie2/base/model/book/timelines/TimelineUnitTest.java

@@ +1 @@
+package org.sophie2.base.model.book.timelines;
+
+import org.junit.Test;
+import org.sophie2.base.model.book.Book;
+import org.sophie2.base.model.book.Page;
+import org.sophie2.core.testing.UnitTestBase;
+
+/**
+ * A unit test for the {@link Timeline}s class. Ensures timeline navigation is
+ * working correctly (playing, pausing, jumping).
+ * 
+ * @author boyan
+ */
+public class TimelineUnitTest extends UnitTestBase {
+
+        /**
+         * A reference to a page that is needed in the {@link Timeline} constructor.
+         */
+        public Page page;
+
+        @Override
+        public void setUp() {
+                Book book = Book.createDefaultBook().get(Book.class);
+                Page p = new Page(book.getSpace());
+                this.page = p;
+        }
+        
+        @Override
+        public void tearDown() {
+                this.page.delete();
+        }
+
+        /**
+         * Tests whether playing/pausing the timeline works. This should affect the
+         * playing() property of the {@link Timeline}.
+         */
+        @Test
+        public void testPlayPause() {
+                Timeline t = new Timeline(this.page);
+                assertFalse(t.playing().get());
+                t.play();
+                assertTrue(t.playing().get());
+                t.pause();
+                assertFalse(t.playing().get());
+        }
+
+        /**
+         * Tests whether a user is able to jump to a location within the timeline.
+         * If the time specified exceeds the timeline length, that should not be
+         * possible.
+         */
+        @Test
+        public void testJumpTo() {
+                Timeline t = new Timeline(this.page, 30);
+
+                assertFalse(t.playing().get());
+                assertEquals(t.headPosition(), t.jumpTo(45));
+
+                t.jumpTo(15);
+                assertEquals(15, t.headPosition());
+        }
+}

src/test/java/org/sophie2/base/model/book/timelines/TimelinesIntegrationTest.java

@@ +1 @@
+package org.sophie2.base.model.book.timelines;
+
+import org.junit.Test;
+import org.sophie2.base.model.book.Book;
+import org.sophie2.base.model.book.Frame;
+import org.sophie2.base.model.book.Page;
+import org.sophie2.core.testing.IntegrationTestBase;
+
+/**
+ * An integration test for timelines, channels and entries. Ensures they are
+ * corresponding to the page structure.
+ * 
+ * @author boyan
+ */
+public class TimelinesIntegrationTest extends IntegrationTestBase {
+        
+        /**
+         * A reference to a page that is needed in the {@link Timeline} constructor.
+         */
+        public Page page;
+
+        @Override
+        public void setUp() {
+                Book book = Book.createDefaultBook().get(Book.class);
+                Page p = new Page(book.getSpace());
+                this.page = p;
+        }
+        
+        @Override
+        public void tearDown() {
+                this.page.delete();
+        }
+
+        /**
+         * Tests that channels are automatically created and removed according to
+         * the groups of elements on the page.
+         */
+        @Test
+        public void testChannels() {
+                Timeline t = new Timeline(this.page);
+                assertEquals(0, t.channels().size());
+
+                this.page.addNewFrame("newFrame");
+                assertEquals(1, t.channels().size());
+
+                this.page.frames().get().clear();
+                assertEquals(0, t.channels().size());
+        }
+
+        /**
+         * Tests timeline entries are added/removed corerctly. An entry holding a
+         * different element from the one the channel holds should not be added to
+         * that channel.
+         */
+        @Test
+        public void testAddRemoveEntries() {
+                Timeline t = new Timeline(this.page);
+                Frame f = this.page.addNewFrame("newFrame");
+                assertEquals(1, t.channels().size());           
+                Channel ch = t.channels().get(1);
+                
+                assertEquals(1, ch.entries().size());
+                ch.addEntry(new TimelineEntry(f));
+                assertEquals(2, ch.entries().size());
+                ch.addEntry(new TimelineEntry(this.page.addNewFrame("Another Frame")));
+                assertEquals(2, ch.entries().size());
+                ch.removeEntry(ch.entries().get(0));
+                assertEquals(1, ch.entries().size());
+        }
+}