com.github.anno4j.model

Interface ExternalWebResource

All Superinterfaces:

CreationProvenance, RDFObject, ResourceObject

All Known Subinterfaces:

Body, Choice, SpecificResource, Target, TextualBody

All Known Implementing Classes:

ChoiceSupport, ExternalWebResourceSupport, SpecificResourceSupport, TextualBodySupport

public interface ExternalWebResource
extends CreationProvenance

The Body and the Target in the Web Annotation Data Model are defined to be an external web resource. The target always has to be, the body can be included in the Annotation. Web Resources are identified with a IRI and have various properties, often including a format or language for the resource's content. This information may be recorded as part of the Annotation, even if the representation of the resource must be retrieved from the Web.

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	addLanguage(String language) Adds a single value to the set of currently set values for the http://purl.org/dc/elements/1.1/language property.
Set<String>	getLanguages() Gets the values currently set for the http://purl.org/dc/elements/1.1/language property.
String	getProcessingLanguage() Gets the value of the http://www.w3.org/ns/oa#processingLanguage property.
ResourceObject	getTextDirection() Gets the value currently set for the http://www.w3.org/ns/oa#textDirection relationship.
void	setLanguages(Set<String> language) Sets the values for the http://purl.org/dc/elements/1.1/language property.
void	setProcessingLanguage(String processingLanguage) Sets the value for the http://www.w3.org/ns/oa#processingLanguage property.
void	setTextDirection(ResourceObject direction) Sets the value for the http://www.w3.org/ns/oa#textDirection relationship.

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

setProcessingLanguage

void setProcessingLanguage(String processingLanguage)

Sets the value for the http://www.w3.org/ns/oa#processingLanguage property. The object of the property is the language that should be used for textual processing algorithms when dealing with the content of the resource, including hyphenation, line breaking, which font to use for rendering and so forth. The value must follow the recommendations of [BCP47].

Parameters:

processingLanguage - The value to set for the http://www.w3.org/ns/oa#processingLanguage property.

getProcessingLanguage

String getProcessingLanguage()

Gets the value of the http://www.w3.org/ns/oa#processingLanguage property. The object of the property is the language that should be used for textual processing algorithms when dealing with the content of the resource, including hyphenation, line breaking, which font to use for rendering and so forth. The value must follow the recommendations of [BCP47].

Returns:

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

setLanguages

void setLanguages(Set<String> language)

Sets the values for the http://purl.org/dc/elements/1.1/language property. The dc:language predicate recommends the use of a controlled vocabulary. The use of dc:language in the Annotation model further specifies that the vocabulary to use is [BCP47].

Parameters:

language - The values to set for the http://purl.org/dc/elements/1.1/language property.

getLanguages

Set<String> getLanguages()

Gets the values currently set for the http://purl.org/dc/elements/1.1/language property. The dc:language predicate recommends the use of a controlled vocabulary. The use of dc:language in the Annotation model further specifies that the vocabulary to use is [BCP47].

Returns:

The set of values currently set for the http://purl.org/dc/elements/1.1/language property.

addLanguage

void addLanguage(String language)

Adds a single value to the set of currently set values for the http://purl.org/dc/elements/1.1/language property.

Parameters:

language - The language value to add to the currently set of values for the http://purl.org/dc/elements/1.1/language property.

setTextDirection

void setTextDirection(ResourceObject direction)

Sets the value for the http://www.w3.org/ns/oa#textDirection relationship. The direction of the text of the subject resource. There must only be one text direction associated with any given resource.

Parameters:

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

getTextDirection

ResourceObject getTextDirection()

Gets the value currently set for the http://www.w3.org/ns/oa#textDirection relationship. The direction of the text of the subject resource. There must only be one text direction associated with any given resource.

Returns:

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