com.github.anno4j.model

Interface Annotation

All Superinterfaces:

CreationProvenance, RDFObject, ResourceObject

All Known Implementing Classes:

AnnotationSupport

public interface Annotation
extends CreationProvenance

Conforms to oa:Annotation (http://www.openannotation.org/spec/core/core.html)

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	addAudience(Audience audience) Adds a single Audience object to the set of Audiences.
void	addBody(Body body) Adds a http:www.w3.org/ns/oa#hasBody relationship.
void	addBodyText(String text) Refers to http://www.w3.org/ns/oa#bodyText
void	addMotivation(Motivation motivation) Add a single http:www.w3.org/ns/oa#motivatedBy relationship.
void	addTarget(Target target) Adds a http:www.w3.org/ns/oa#hasTarget relationship.
String	getAnnotatedAt() Deprecated.
Agent	getAnnotatedBy() Deprecated.
Set<Audience>	getAudiences() Gets the set of values for the http://schema.org/audience relationship.
Set<Body>	getBodies() Gets http:www.w3.org/ns/oa#hasBody relationship.
Set<String>	getBodyTexts() Refers to http://www.w3.org/ns/oa#bodyText
String	getGenerated() Gets the value of the http://purl.org/dc/terms/issued property.
Agent	getGenerator() Gets the value of the http://www.w3.org/ns/activitystreams#generator relationship.
Set<Motivation>	getMotivatedBy() Gets http:www.w3.org/ns/oa#motivatedBy relationship.
String	getSerializedAt() Deprecated.
Agent	getSerializedBy() Deprecated.
Style	getStyledBy() Gets the value currently set for the http://www.w3.org/ns/oa#styledBy relationship.
Set<Target>	getTargets() Gets http:www.w3.org/ns/oa#hasTarget relationships.
void	setAnnotatedAt(int year, int month, int day, int hours, int minutes, int seconds, String timezoneID) Deprecated.
void	setAnnotatedAt(String annotatedAt) Deprecated.
void	setAnnotatedBy(Agent annotatedBy) Deprecated.
void	setAudiences(Set<Audience> audiences) Sets the set of values for the http://schema.org/audience relationship.
void	setBodies(Set<Body> body) Sets http:www.w3.org/ns/oa#hasBody.
void	setBodyTexts(Set<String> texts) Refers to http://www.w3.org/ns/oa#bodyText
void	setGenerated(int year, int month, int day, int hours, int minutes, int seconds, String timezoneID) Sets the value of the http://purl.org/dc/terms/issued property.
void	setGenerated(String generated) Sets the value of the http://purl.org/dc/terms/issued property.
void	setGenerator(Agent generator) Sets the value of the http://www.w3.org/ns/activitystreams#generator relationship.
void	setMotivatedBy(Set<Motivation> motivatedBy) Sets http:www.w3.org/ns/oa#motivatedBy.
void	setSerializedAt(int year, int month, int day, int hours, int minutes, int seconds, String timezoneID) Deprecated.
void	setSerializedAt(String serializedAt) Deprecated.
void	setSerializedBy(Agent serializedBy) Deprecated.
void	setStyledBy(Style stylesheet) Sets the value for the http://www.w3.org/ns/oa#styledBy relationship.
void	setTargets(Set<Target> targets) Sets http:www.w3.org/ns/oa#hasTarget.

Methods inherited from interface com.github.anno4j.model.CreationProvenance

addRight, addVia, getCanonical, getCreated, getCreator, getModified, getRights, getVia, setCanonical, setCreated, setCreated, setCreator, setModified, setModified, setRights, setVia

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

getBodies

Set<Body> getBodies()

Gets http:www.w3.org/ns/oa#hasBody relationship.

Returns:

Value of http:www.w3.org/ns/oa#hasBody.

setBodies

void setBodies(Set<Body> body)

Sets http:www.w3.org/ns/oa#hasBody.

Parameters:

body - New value of http:www.w3.org/ns/oa#hasBody.

addBody

void addBody(Body body)

Adds a http:www.w3.org/ns/oa#hasBody relationship.

Parameters:

body - New http:www.w3.org/ns/oa#hasBody relationship.

getTargets

Set<Target> getTargets()

Gets http:www.w3.org/ns/oa#hasTarget relationships.

Returns:

Values of http:www.w3.org/ns/oa#hasTarget.

setTargets

void setTargets(Set<Target> targets)

Sets http:www.w3.org/ns/oa#hasTarget.

Parameters:

targets - New value of http:www.w3.org/ns/oa#hasTarget.

addTarget

void addTarget(Target target)

Adds a http:www.w3.org/ns/oa#hasTarget relationship.

Parameters:

target - New http:www.w3.org/ns/oa#hasTarget relationship.

getMotivatedBy

Set<Motivation> getMotivatedBy()

Gets http:www.w3.org/ns/oa#motivatedBy relationship.

Returns:

Value of http:www.w3.org/ns/oa/#motivatedBy.

setMotivatedBy

void setMotivatedBy(Set<Motivation> motivatedBy)

Sets http:www.w3.org/ns/oa#motivatedBy.

Parameters:

motivatedBy - New value of http:www.w3.org/ns/oa#motivatedBy.

addMotivation

void addMotivation(Motivation motivation)

Add a single http:www.w3.org/ns/oa#motivatedBy relationship.

Parameters:

motivation - The Motivation to add to this Annotation node.

getBodyTexts

Set<String> getBodyTexts()

Refers to http://www.w3.org/ns/oa#bodyText

Returns:

Returns the currently set bodyText properties.

setBodyTexts

void setBodyTexts(Set<String> texts)

Refers to http://www.w3.org/ns/oa#bodyText

Parameters:

texts - A Set of Strings to set for this nodes bodyText property.

addBodyText

void addBodyText(String text)

Refers to http://www.w3.org/ns/oa#bodyText

Parameters:

text - Adds the single text as textBody property.

getGenerator

Agent getGenerator()

Gets the value of the http://www.w3.org/ns/activitystreams#generator relationship.

Returns:

The Agent of the as:generator relationship.

setGenerator

void setGenerator(Agent generator)

Sets the value of the http://www.w3.org/ns/activitystreams#generator relationship.

Parameters:

generator - The Agent to set for the as:generator relationship.

getGenerated

String getGenerated()

Gets the value of the http://purl.org/dc/terms/issued property.

Returns:

The timestamp value of the dcterms:issued property.

setGenerated

void setGenerated(String generated)

Sets the value of the http://purl.org/dc/terms/issued property.

Parameters:

generated - The timestamp value to set for the dcterms:issued property.

setGenerated

void setGenerated(int year,
                int month,
                int day,
                int hours,
                int minutes,
                int seconds,
                String timezoneID)

Sets the value of the http://purl.org/dc/terms/issued property.

Parameters:

year - The year to set.

month - The month to set.

day - The day to set.

hours - The hours to set.

minutes - The minutes to set.

seconds - The seconds to set.

timezoneID - The timezone to set.

getSerializedBy

@Deprecated
Agent getSerializedBy()

Deprecated.

Gets http:www.w3.org/ns/oa#serializedBy relationship.

Returns:

Value of http:www.w3.org/ns/oa#serializedBy.

setSerializedBy

@Deprecated
void setSerializedBy(Agent serializedBy)

Deprecated.

Sets http:www.w3.org/ns/oa#serializedBy.

Parameters:

serializedBy - New value of http:www.w3.org/ns/oa#serializedBy.

getAnnotatedBy

@Deprecated
Agent getAnnotatedBy()

Deprecated.

Gets http:www.w3.org/ns/oa#annotatedBy relationship.

Returns:

Value of http:www.w3.org/ns/oa#annotatedBy.

setAnnotatedBy

@Deprecated
void setAnnotatedBy(Agent annotatedBy)

Deprecated.

Sets http:www.w3.org/ns/oa#annotatedBy.

Parameters:

annotatedBy - New value of http:www.w3.org/ns/oa#annotatedBy.

getSerializedAt

@Deprecated
String getSerializedAt()

Deprecated.

Gets http:www.w3.org/ns/oa#serializedAt relationship.

Returns:

Value of http:www.w3.org/ns/oa#serializedAt.

setSerializedAt

@Deprecated
void setSerializedAt(String serializedAt)

Deprecated.

Sets http:www.w3.org/ns/oa#serializedAt.

Parameters:

serializedAt - New value of http:www.w3.org/ns/oa#serializedAt.

setSerializedAt

@Deprecated
void setSerializedAt(int year,
                              int month,
                              int day,
                              int hours,
                              int minutes,
                              int seconds,
                              String timezoneID)

Deprecated.

Sets http:www.w3.org/ns/oa#serializedAt according to the format year-month-dayThours:minutes:secondsZ, e.g. 2015-12-16T12:00:00Z.

Parameters:

year - The year to set.

month - The month to set.

day - The day to set.

hours - The hours to set.

minutes - The minutes to set.

seconds - The seconds to set.

timezoneID - The timezone to set.

getAnnotatedAt

@Deprecated
String getAnnotatedAt()

Deprecated.

Gets http:www.w3.org/ns/oa#annotatedAt relationship.

Returns:

Value of http:www.w3.org/ns/oa#annotatedAt.

setAnnotatedAt

@Deprecated
void setAnnotatedAt(String annotatedAt)

Deprecated.

Sets http:www.w3.org/ns/oa#annotatedAt.

Parameters:

annotatedAt - New value of http:www.w3.org/ns/oa#annotatedAt.

setAnnotatedAt

@Deprecated
void setAnnotatedAt(int year,
                             int month,
                             int day,
                             int hours,
                             int minutes,
                             int seconds,
                             String timezoneID)

Deprecated.

Sets http:www.w3.org/ns/oa#annotatedAt according to the format year-month-dayThours:minutes:secondsZ, e.g. 2015-12-16T12:00:00Z.

Parameters:

year - The year to set.

month - The month to set.

day - The day to set.

hours - The hours to set.

minutes - The minutes to set.

seconds - The seconds to set.

timezoneID - The timezone to set.

setAudiences

void setAudiences(Set<Audience> audiences)

Sets the set of values for the http://schema.org/audience relationship.

Parameters:

audiences - The audiences to set for the http://schema.org/audience relationship.

getAudiences

Set<Audience> getAudiences()

Gets the set of values for the http://schema.org/audience relationship.

Returns:

A set of Audience objects related to the http://schema.org/audience relationship.

addAudience

void addAudience(Audience audience)

Adds a single Audience object to the set of Audiences.

Parameters:

audience - The Audience to add

setStyledBy

void setStyledBy(Style stylesheet)

Sets the value for the http://www.w3.org/ns/oa#styledBy relationship. A reference to a Stylesheet that should be used to apply styles to the Annotation rendering.

Parameters:

stylesheet - The value to set for the http://www.w3.org/ns/oa#styledBy relationship.

getStyledBy

Style getStyledBy()

Gets the value currently set for the http://www.w3.org/ns/oa#styledBy relationship. A reference to a Stylesheet that should be used to apply styles to the Annotation rendering.

Returns:

The value currently set for the http://www.w3.org/ns/oa#styledBy relationship.