Class HydraVocab

java.lang.Object

se.liu.ida.hefquin.vocabulary.HydraVocab

public class HydraVocab
extends Object

Vocabulary definitions from https://www.w3.org/ns/hydra/core.jsonld

Author:

Auto-generated by schemagen on 27 Jan 2026 17:04

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.jena.rdf.model.Resource	apiDocumentation	A link to the API documentation
static final org.apache.jena.rdf.model.Resource	ApiDocumentation	The Hydra API documentation class
static final org.apache.jena.rdf.model.Resource	BaseUriSource	Provides a base abstract for base Uri source for Iri template resolution.
static final org.apache.jena.rdf.model.Resource	BasicRepresentation	A representation that serializes just the lexical form of a variable value, but omits language and type information.
static final org.apache.jena.rdf.model.Resource	Class	The class of Hydra classes.
static final org.apache.jena.rdf.model.Property	closedSet	Determines whether the provided set of header values is closed or not.
static final org.apache.jena.rdf.model.Resource	collection	Collections somehow related to this resource.
static final org.apache.jena.rdf.model.Resource	Collection	A collection holding references to a number of related resources.
static final org.apache.jena.rdf.model.Property	description	A description.
static final org.apache.jena.rdf.model.Resource	entrypoint	A link to main entry point of the Web API
static final org.apache.jena.rdf.model.Resource	Error	A runtime error, used to report information beyond the returned status code.
static final org.apache.jena.rdf.model.Resource	expects	The information expected by the Web API.
static final org.apache.jena.rdf.model.Property	expectsHeader	Specification of the header expected by the operation.
static final org.apache.jena.rdf.model.Resource	ExplicitRepresentation	A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.
static final org.apache.jena.rdf.model.Property	extension	Hint on what kind of extensions are in use.
static final org.apache.jena.rdf.model.Resource	first	The first resource of an interlinked set of resources.
static final org.apache.jena.rdf.model.Property	freetextQuery	A property representing a freetext query.
static final org.apache.jena.rdf.model.Property	headerName	Name of the header.
static final org.apache.jena.rdf.model.Resource	IriTemplate	The class of IRI templates.
static final org.apache.jena.rdf.model.Resource	IriTemplateMapping	A mapping from an IRI template variable to a property.
static final org.apache.jena.rdf.model.Resource	last	The last resource of an interlinked set of resources.
static final org.apache.jena.rdf.model.Property	limit	Instructs to limit set only to N elements.
static final org.apache.jena.rdf.model.Resource	Link	The class of properties representing links.
static final org.apache.jena.rdf.model.Resource	LinkContext	States that the link's context IRI, as defined in RFC 5988, should be used as the base Uri
static final org.apache.jena.rdf.model.Property	mapping	A variable-to-property mapping of the IRI template.
static final org.apache.jena.rdf.model.Resource	member	A member of the collection
static final org.apache.jena.rdf.model.Property	method	The HTTP method.
static final org.apache.jena.rdf.model.Resource	NAMESPACE	The namespace of the vocabulary as a resource
static final org.apache.jena.rdf.model.Resource	next	The resource following the current instance in an interlinked set of resources.
static final String	NS	The namespace of the vocabulary as a string
static final org.apache.jena.rdf.model.Property	offset	Instructs to skip N elements of the set.
static final org.apache.jena.rdf.model.Resource	operation	An operation supported by the Hydra resource
static final org.apache.jena.rdf.model.Resource	Operation	An operation.
static final org.apache.jena.rdf.model.Property	pageIndex	Instructs to provide a specific page of the collection at a given index.
static final org.apache.jena.rdf.model.Property	pageReference	Instructs to provide a specific page reference of the collection.
static final org.apache.jena.rdf.model.Resource	PartialCollectionView	A PartialCollectionView describes a partial view of a Collection.
static final org.apache.jena.rdf.model.Resource	possibleStatus	A status that might be returned by the Web API (other statuses should be expected and properly handled as well)
static final org.apache.jena.rdf.model.Property	possibleValue	Possible value of the header.
static final org.apache.jena.rdf.model.Resource	previous	The resource preceding the current instance in an interlinked set of resources.
static final org.apache.jena.rdf.model.Property	property	A property
static final org.apache.jena.rdf.model.Property	readable	True if the client can retrieve the property's value, false otherwise.
static final org.apache.jena.rdf.model.Property	required	True if the property is required, false otherwise.
static final org.apache.jena.rdf.model.Property	resolveRelativeUsing
static final org.apache.jena.rdf.model.Resource	Resource	The class of dereferenceable resources by means a client can attempt to dereference; however, the received responses should still be verified.
static final org.apache.jena.rdf.model.Resource	returns	The information returned by the Web API on success
static final org.apache.jena.rdf.model.Property	returnsHeader	Name of the header returned by the operation.
static final org.apache.jena.rdf.model.Resource	Rfc3986	States that the base Uri should be established using RFC 3986 reference resolution algorithm specified in section 5.
static final org.apache.jena.rdf.model.Resource	Rfc6570Template	An IRI template as defined by RFC6570.
static final org.apache.jena.rdf.model.Resource	search	A IRI template that can be used to query a collection.
static final org.apache.jena.rdf.model.Resource	Status	Additional information about a status code that might be returned.
static final org.apache.jena.rdf.model.Property	statusCode	The HTTP status code.
static final org.apache.jena.rdf.model.Resource	supportedClass	A class known to be supported by the Web API
static final org.apache.jena.rdf.model.Resource	supportedOperation	An operation supported by instances of the specific Hydra class, or the target of the Hydra link, or IRI template.
static final org.apache.jena.rdf.model.Resource	supportedProperty	The properties known to be supported by a Hydra class
static final org.apache.jena.rdf.model.Resource	SupportedProperty	A property known to be supported by a Hydra class.
static final org.apache.jena.rdf.model.Property	template	A templated string with placeholders.
static final org.apache.jena.rdf.model.Resource	TemplatedLink	A templated link.
static final org.apache.jena.rdf.model.Property	title	A title, often used along with a description.
static final org.apache.jena.rdf.model.Property	totalItems	The total number of items referenced by a collection.
static final org.apache.jena.rdf.model.Property	variable	An IRI template variable
static final org.apache.jena.rdf.model.Property	variableRepresentation	The representation format to use when expanding the IRI template.
static final org.apache.jena.rdf.model.Resource	VariableRepresentation	A representation specifies how to serialize variable values into strings.
static final org.apache.jena.rdf.model.Resource	view	A specific view of a resource.
static final org.apache.jena.rdf.model.Property	writable	True if the client can change the property's value, false otherwise.

Constructor Summary

Constructors

Constructor	Description
HydraVocab()

Method Summary

Modifier and Type	Method	Description
static String	getURI()	The namespace of the vocabulary as a string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NS

public static final String NS

The namespace of the vocabulary as a string

See Also:

• Constant Field Values

NAMESPACE

public static final org.apache.jena.rdf.model.Resource NAMESPACE

The namespace of the vocabulary as a resource

closedSet

public static final org.apache.jena.rdf.model.Property closedSet

Determines whether the provided set of header values is closed or not.

description

public static final org.apache.jena.rdf.model.Property description

A description.

expectsHeader

public static final org.apache.jena.rdf.model.Property expectsHeader

Specification of the header expected by the operation.

extension

public static final org.apache.jena.rdf.model.Property extension

Hint on what kind of extensions are in use.

freetextQuery

public static final org.apache.jena.rdf.model.Property freetextQuery

A property representing a freetext query.

headerName

public static final org.apache.jena.rdf.model.Property headerName

Name of the header.

limit

public static final org.apache.jena.rdf.model.Property limit

Instructs to limit set only to N elements.

mapping

public static final org.apache.jena.rdf.model.Property mapping

A variable-to-property mapping of the IRI template.

method

public static final org.apache.jena.rdf.model.Property method

The HTTP method.

offset

public static final org.apache.jena.rdf.model.Property offset

Instructs to skip N elements of the set.

pageIndex

public static final org.apache.jena.rdf.model.Property pageIndex

Instructs to provide a specific page of the collection at a given index.

pageReference

public static final org.apache.jena.rdf.model.Property pageReference

Instructs to provide a specific page reference of the collection.

possibleValue

public static final org.apache.jena.rdf.model.Property possibleValue

Possible value of the header.

property

public static final org.apache.jena.rdf.model.Property property

A property

readable

public static final org.apache.jena.rdf.model.Property readable

True if the client can retrieve the property's value, false otherwise.

required

public static final org.apache.jena.rdf.model.Property required

True if the property is required, false otherwise.

resolveRelativeUsing

public static final org.apache.jena.rdf.model.Property resolveRelativeUsing

returnsHeader

public static final org.apache.jena.rdf.model.Property returnsHeader

Name of the header returned by the operation.

statusCode

public static final org.apache.jena.rdf.model.Property statusCode

The HTTP status code. Please note it may happen this value will be different to actual status code received.

template

public static final org.apache.jena.rdf.model.Property template

A templated string with placeholders. The literal's datatype indicates the template syntax; if not specified, hydra:Rfc6570Template is assumed.

title

public static final org.apache.jena.rdf.model.Property title

A title, often used along with a description.

totalItems

public static final org.apache.jena.rdf.model.Property totalItems

The total number of items referenced by a collection.

variable

public static final org.apache.jena.rdf.model.Property variable

An IRI template variable

variableRepresentation

public static final org.apache.jena.rdf.model.Property variableRepresentation

The representation format to use when expanding the IRI template.

writable

public static final org.apache.jena.rdf.model.Property writable

True if the client can change the property's value, false otherwise.

ApiDocumentation

public static final org.apache.jena.rdf.model.Resource ApiDocumentation

The Hydra API documentation class

BaseUriSource

public static final org.apache.jena.rdf.model.Resource BaseUriSource

Provides a base abstract for base Uri source for Iri template resolution.

BasicRepresentation

public static final org.apache.jena.rdf.model.Resource BasicRepresentation

A representation that serializes just the lexical form of a variable value, but omits language and type information.

Class

public static final org.apache.jena.rdf.model.Resource Class

The class of Hydra classes.

Collection

public static final org.apache.jena.rdf.model.Resource Collection

A collection holding references to a number of related resources.

Error

public static final org.apache.jena.rdf.model.Resource Error

A runtime error, used to report information beyond the returned status code.

ExplicitRepresentation

public static final org.apache.jena.rdf.model.Resource ExplicitRepresentation

A representation that serializes a variable value including its language and type information and thus differentiating between IRIs and literals.

IriTemplate

public static final org.apache.jena.rdf.model.Resource IriTemplate

The class of IRI templates.

IriTemplateMapping

public static final org.apache.jena.rdf.model.Resource IriTemplateMapping

A mapping from an IRI template variable to a property.

Link

public static final org.apache.jena.rdf.model.Resource Link

The class of properties representing links.

LinkContext

public static final org.apache.jena.rdf.model.Resource LinkContext

States that the link's context IRI, as defined in RFC 5988, should be used as the base Uri

Operation

public static final org.apache.jena.rdf.model.Resource Operation

An operation.

PartialCollectionView

public static final org.apache.jena.rdf.model.Resource PartialCollectionView

A PartialCollectionView describes a partial view of a Collection. Multiple PartialCollectionViews can be connected with the the next/previous properties to allow a client to retrieve all members of the collection.

Resource

public static final org.apache.jena.rdf.model.Resource Resource

The class of dereferenceable resources by means a client can attempt to dereference; however, the received responses should still be verified.

Rfc3986

public static final org.apache.jena.rdf.model.Resource Rfc3986

States that the base Uri should be established using RFC 3986 reference resolution algorithm specified in section 5.

Status

public static final org.apache.jena.rdf.model.Resource Status

Additional information about a status code that might be returned.

SupportedProperty

public static final org.apache.jena.rdf.model.Resource SupportedProperty

A property known to be supported by a Hydra class.

TemplatedLink

public static final org.apache.jena.rdf.model.Resource TemplatedLink

A templated link.

VariableRepresentation

public static final org.apache.jena.rdf.model.Resource VariableRepresentation

A representation specifies how to serialize variable values into strings.

apiDocumentation

public static final org.apache.jena.rdf.model.Resource apiDocumentation

A link to the API documentation

collection

public static final org.apache.jena.rdf.model.Resource collection

Collections somehow related to this resource.

entrypoint

public static final org.apache.jena.rdf.model.Resource entrypoint

A link to main entry point of the Web API

expects

public static final org.apache.jena.rdf.model.Resource expects

The information expected by the Web API.

first

public static final org.apache.jena.rdf.model.Resource first

The first resource of an interlinked set of resources.

last

public static final org.apache.jena.rdf.model.Resource last

The last resource of an interlinked set of resources.

member

public static final org.apache.jena.rdf.model.Resource member

A member of the collection

next

public static final org.apache.jena.rdf.model.Resource next

The resource following the current instance in an interlinked set of resources.

operation

public static final org.apache.jena.rdf.model.Resource operation

An operation supported by the Hydra resource

possibleStatus

public static final org.apache.jena.rdf.model.Resource possibleStatus

A status that might be returned by the Web API (other statuses should be expected and properly handled as well)

previous

public static final org.apache.jena.rdf.model.Resource previous

The resource preceding the current instance in an interlinked set of resources.

returns

public static final org.apache.jena.rdf.model.Resource returns

The information returned by the Web API on success

search

public static final org.apache.jena.rdf.model.Resource search

A IRI template that can be used to query a collection.

supportedClass

public static final org.apache.jena.rdf.model.Resource supportedClass

A class known to be supported by the Web API

supportedOperation

public static final org.apache.jena.rdf.model.Resource supportedOperation

An operation supported by instances of the specific Hydra class, or the target of the Hydra link, or IRI template.

supportedProperty

public static final org.apache.jena.rdf.model.Resource supportedProperty

The properties known to be supported by a Hydra class

view

public static final org.apache.jena.rdf.model.Resource view

A specific view of a resource.

Rfc6570Template

public static final org.apache.jena.rdf.model.Resource Rfc6570Template

An IRI template as defined by RFC6570.

Constructor Details

HydraVocab

public HydraVocab()

Method Details

getURI

public static String getURI()

The namespace of the vocabulary as a string

Returns:

namespace as String

See Also:

• NS