com.github.anno4j.model.impl.collection

Interface AnnotationPage

All Superinterfaces:

RDFObject, ResourceObject

All Known Implementing Classes:

AnnotationPageSupport

public interface AnnotationPage
extends ResourceObject

Refers to http://www.w3.org/ns/activitystreams#OrderedCollectionPage. An Annotation Page is part of an Annotation Collection, and has an ordered list of some or all of the Annotations that are within the Collection. Each Collection may have multiple pages, and these are traversed by following the next and prev links between the pages.

Field Summary

Fields inherited from interface org.openrdf.repository.object.RDFObject

GET_CONNECTION, GET_RESOURCE

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(Annotation annotation) Adds a single value to the Set of values currently defined for the http://www.w3.org/ns/activitystreams#items relationship.
Set<Annotation>	getItems() Gets the Set of values currently defined for the http://www.w3.org/ns/activitystreams#items relationship.
AnnotationPage	getNext() Gets the value currently defined for the http://www.w3.org/ns/activitystreams#next relationship.
AnnotationCollection	getPartOf() Gets the value currently set for the http://www.w3.org/ns/activitystreams#partOf relationship.
AnnotationPage	getPrev() Gets the value currently defined for the http://www.w3.org/ns/activitystreams#prev relationship.
int	getStartIndex() Gets the value currently defined for the http://www.w3.org/ns/activitystreams#startIndex property.
void	setItems(Set<Annotation> items) Sets the Set of values for the http://www.w3.org/ns/activitystreams#items relationship.
void	setNext(AnnotationPage page) Sets the value for the http://www.w3.org/ns/activitystreams#next relationship.
void	setPartOf(AnnotationCollection collection) Sets the value of the http://www.w3.org/ns/activitystreams#partOf relationship.
void	setPrev(AnnotationPage page) Sets the value for the http://www.w3.org/ns/activitystreams#prev relationship.
void	setStartIndex(int index) Sets the value for the http://www.w3.org/ns/activitystreams#startIndex property.

Methods inherited from interface com.github.anno4j.model.impl.ResourceObject

delete, getResourceAsString, getTriples, setResource, setResourceAsString

Methods inherited from interface org.openrdf.repository.object.RDFObject

getObjectConnection, getResource

Method Detail

setPartOf

void setPartOf(AnnotationCollection collection)

Sets the value of the http://www.w3.org/ns/activitystreams#partOf relationship. The relationship between the Page and the Annotation Collection that it is part of.

Parameters:

collection - The value to set for the http://www.w3.org/ns/activitystreams#partOf relationship.

getPartOf

AnnotationCollection getPartOf()

Gets the value currently set for the http://www.w3.org/ns/activitystreams#partOf relationship. The relationship between the Page and the Annotation Collection that it is part of.

Returns:

The value currently defined for the http://www.w3.org/ns/activitystreams#partOf relationship.

setItems

void setItems(Set<Annotation> items)

Sets the Set of values for the http://www.w3.org/ns/activitystreams#items relationship. The list of Annotations that are the members of the Page.

Parameters:

items - The Set of values to set for the http://www.w3.org/ns/activitystreams#items relationship.

getItems

Set<Annotation> getItems()

Gets the Set of values currently defined for the http://www.w3.org/ns/activitystreams#items relationship. The list of Annotations that are the members of the Page.

Returns:

The Set of values currently defined for the http://www.w3.org/ns/activitystreams#items relationship.

addItem

void addItem(Annotation annotation)

Adds a single value to the Set of values currently defined for the http://www.w3.org/ns/activitystreams#items relationship.

Parameters:

annotation - The Annotation to add to the Set of Annotations currently defined for the http://www.w3.org/ns/activitystreams#items relationship.

setNext

void setNext(AnnotationPage page)

Sets the value for the http://www.w3.org/ns/activitystreams#next relationship. A reference to the next Page in the sequence of pages that make up the Collection.

Parameters:

page - The AnnotationPage to set the http://www.w3.org/ns/activitystreams#next relationship to.

getNext

AnnotationPage getNext()

Gets the value currently defined for the http://www.w3.org/ns/activitystreams#next relationship. A reference to the next Page in the sequence of pages that make up the Collection.

Returns:

The AnnotationPage that is currently set for the http://www.w3.org/ns/activitystreams#next relationship.

setPrev

void setPrev(AnnotationPage page)

Sets the value for the http://www.w3.org/ns/activitystreams#prev relationship. A reference to the previous Page in the sequence of pages that make up the Collection.

Parameters:

page - The AnnotationPage to set the http://www.w3.org/ns/activitystreams#prev relationship to.

getPrev

AnnotationPage getPrev()

Gets the value currently defined for the http://www.w3.org/ns/activitystreams#prev relationship. A reference to the previous Page in the sequence of pages that make up the Collection.

Returns:

The AnnotationPage that is currently set for the http://www.w3.org/ns/activitystreams#prev relationship.

setStartIndex

void setStartIndex(int index)

Sets the value for the http://www.w3.org/ns/activitystreams#startIndex property. The relative position of the first Annotation in the items list, relative to the Annotation Collection. The first entry in the first page is considered to be entry 0.

Parameters:

index - The value to set for the http://www.w3.org/ns/activitystreams#startIndex property.

getStartIndex

int getStartIndex()

Gets the value currently defined for the http://www.w3.org/ns/activitystreams#startIndex property. The relative position of the first Annotation in the items list, relative to the Annotation Collection. The first entry in the first page is considered to be entry 0.

Returns:

The value currently defined for the http://www.w3.org/ns/activitystreams#startIndex property.