org.ldp4j.application.vocabulary

Interface Vocabulary<T extends Term>

All Superinterfaces:

Iterable<T>, Serializable

All Known Implementing Classes:

AbstractImmutableVocabulary, LDP, RDF, RDFS

public interface Vocabulary<T extends Term>
extends Iterable<T>, Serializable

A class for representing a vocabularies. The interface includes facilities for discovering the terms defined in the vocabulary. methods for retrieving the representation of the particular term in different formats.

Since:

1.0.0

Version:

1.0

Author:

Miguel Esteban Gutiérrez

See Also:

Term

Method Summary

Methods

Modifier and Type	Method and Description
T	fromName(String name) Returns the vocabulary term with the specified name.
T	fromOrdinal(int ordinal) Returns the vocabulary term specified in a given position.
<V> T	fromValue(V value) Returns the vocabulary term that matches the specified value.
String	getNamespace() Get the namespace of the vocabulary.
String	getPreferredPrefix() Get the preferred prefix for the vocabulary namespace.
int	size() Get the number of terms defined in the vocabulary.
T[]	terms() Get the terms defined in the vocabulary.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getNamespace

String getNamespace()

Get the namespace of the vocabulary.

Returns:

the namespace of the vocabulary. It should never be null nor empty.

getPreferredPrefix

String getPreferredPrefix()

Get the preferred prefix for the vocabulary namespace.

Returns:

the preferred prefix for the namespace. It should never be null nor empty.

size

int size()

Get the number of terms defined in the vocabulary.

Returns:

the number of terms defined or 0 if no term is defined.

terms

T[] terms()

Get the terms defined in the vocabulary.

Returns:

the terms defined for the vocabulary or an empty array if no terms are defined.

fromName

T fromName(String name)

Returns the vocabulary term with the specified name. The name must match exactly an identifier used to declare the term in this vocabulary.

Parameters:

name - the name of the term to return

Returns:

the term of the vocabulary type with the specified name

Throws:

IllegalArgumentException - if name is null.

fromOrdinal

T fromOrdinal(int ordinal)

Returns the vocabulary term specified in a given position.

Parameters:

ordinal - the position in which the desired term was declared.

Returns:

the term that was declared in the specified position.

Throws:

IndexOutOfBoundsException - if the specified ordinal is lower than 0 or greater or equal than #size().

fromValue

<V> T fromValue(V value)

Returns the vocabulary term that matches the specified value.

Parameters:

value - a value to determine the desired term.

Returns:

the term that upon transformation matches the specified value.

Throws:

UnsupportedOperationException - if the terms of the vocabulary cannot be transformed to instances a compatible class.

See Also:

Term.as(Class)