com.github.anno4j.model.impl.collection

Interface AnnotationCollection

All Superinterfaces:

RDFObject, ResourceObject

All Known Implementing Classes:

AnnotationCollectionSupport

public interface AnnotationCollection
extends ResourceObject

Refers to http://www.w3.org/ns/activitystreams#OrderedCollection. It is often useful to be able to collect Annotations together into a list, called an Annotation Collection. This list, which is always ordered, serves as a means to refer to the Annotations that are contained within it, and to maintain any information about the Collection itself.

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	addLabel(String label) Adds a single value to the currently defined Set for the http://www.w3.org/2000/01/rdf-schema#label relationship.
AnnotationPage	getFirstPage() Gets the AnnotationPage currently defined at the http://www.w3.org/ns/activitystreams#first relationship.
Set<String>	getLabels() Gets the Set of values currently defined for the http://www.w3.org/2000/01/rdf-schema#label relationship.
AnnotationPage	getLastPage() Gets the AnnotationPage currently defined for the http://www.w3.org/ns/activitystreams#last relationship.
int	getTotal() Gets the currently defined value for the http://www.w3.org/ns/activitystreams#totalItems relationship.
void	setFirstPage(AnnotationPage page) Sets the value of the http://www.w3.org/ns/activitystreams#first relationship.
void	setLabels(Set<String> labels) Sets the Set of values for the http://www.w3.org/2000/01/rdf-schema#label relationship.
void	setLastPage(AnnotationPage page) Sets the value for the http://www.w3.org/ns/activitystreams#last relationship.
void	setTotal(int total) Sets the value for the http://www.w3.org/ns/activitystreams#totalItems relationship.

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

setLabels

void setLabels(Set<String> labels)

Sets the Set of values for the http://www.w3.org/2000/01/rdf-schema#label relationship. A human readable label intended as the name of the Collection.

Parameters:

labels - The Set of values to set for the http://www.w3.org/2000/01/rdf-schema#label relationship.

getLabels

Set<String> getLabels()

Gets the Set of values currently defined for the http://www.w3.org/2000/01/rdf-schema#label relationship. A human readable label intended as the name of the Collection.

Returns:

The Set of values currently defined for the http://www.w3.org/2000/01/rdf-schema#label relationship.

addLabel

void addLabel(String label)

Adds a single value to the currently defined Set for the http://www.w3.org/2000/01/rdf-schema#label relationship.

Parameters:

label - The single label to add to the currently defined values of the http://www.w3.org/2000/01/rdf-schema#label relationship.

setTotal

void setTotal(int total)

Sets the value for the http://www.w3.org/ns/activitystreams#totalItems relationship. The total number of Annotations in the Collection.

Parameters:

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

getTotal

int getTotal()

Gets the currently defined value for the http://www.w3.org/ns/activitystreams#totalItems relationship. The total number of Annotations in the Collection.

Returns:

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

setFirstPage

void setFirstPage(AnnotationPage page)

Sets the value of the http://www.w3.org/ns/activitystreams#first relationship. The first page of Annotations that are included within the Collection.

Parameters:

page - The AnnotationPage to define the http://www.w3.org/ns/activitystreams#first relationship point to.

getFirstPage

AnnotationPage getFirstPage()

Gets the AnnotationPage currently defined at the http://www.w3.org/ns/activitystreams#first relationship. The first page of Annotations that are included within the Collection.

Returns:

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

setLastPage

void setLastPage(AnnotationPage page)

Sets the value for the http://www.w3.org/ns/activitystreams#last relationship. The last page of Annotations that are included within the Collection.

Parameters:

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

getLastPage

AnnotationPage getLastPage()

Gets the AnnotationPage currently defined for the http://www.w3.org/ns/activitystreams#last relationship. The last page of Annotations that are included within the Collection.

Returns:

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