org.ldp4j.application.vocabulary

Interface Term

All Superinterfaces:

Comparable<Term>, Serializable

All Known Implementing Classes:

ImmutableTerm

public interface Term
extends Comparable<Term>, Serializable

The class represents the terms of a vocabulary. The class includes different mechanisms for identifying the term as well as utility methods for transforming the term into different types.

Since:

1.0.0

Version:

1.0

Author:

Miguel Esteban Gutiérrez

See Also:

Vocabulary

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	as(Class<? extends T> type) Transform the term to an instance of the specified type.
String	entityName() Returns the simple name of the entity of the vocabulary identified by this term constant.
Vocabulary	getDeclaringVocabulary() Returns the Vocabulary object corresponding to this term constant's vocabulary type.
String	name() Returns the name of this term constant, exactly as declared in its vocabulary declaration.
int	ordinal() Returns the ordinal of this term (its position in its vocabulary declaration, where the initial constant is assigned an ordinal of zero).
String	qualifiedEntityName() Returns the qualified name of the entity of the vocabulary identified by this term constant.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

ordinal

int ordinal()

Returns the ordinal of this term (its position in its vocabulary declaration, where the initial constant is assigned an ordinal of zero).

Returns:

the ordinal of this term

name

String name()

Returns the name of this term constant, exactly as declared in its vocabulary declaration. Most programmers should use the #toString method in preference to this one, as the toString method may return a more user-friendly name. This method is designed primarily for use in specialized situations where correctness depends on getting the exact name, which will not vary from release to release.

Returns:

the name of this term

entityName

String entityName()

Returns the simple name of the entity of the vocabulary identified by this term constant.

qualifiedEntityName

String qualifiedEntityName()

Returns the qualified name of the entity of the vocabulary identified by this term constant.

getDeclaringVocabulary

Vocabulary getDeclaringVocabulary()

Returns the Vocabulary object corresponding to this term constant's vocabulary type. Two term constants e1 and e2 are of the same vocabulary type if and only if e1.getDeclaringVocabulary() == e2.getDeclaringVocabulary().

Returns:

the Vocabulary object corresponding to this term constant's vocabulary type

as

<T> T as(Class<? extends T> type)

Transform the term to an instance of the specified type.

Parameters:

type - The type to which the term is to be transformed to.

Returns:

An instance of the specified type that represents this term.

Throws:

UnsupportedOperationException - if the term cannot be transformed to the specified type.