org.ldp4j.application.vocabulary

Class AbstractImmutableVocabulary<T extends ImmutableTerm>

java.lang.Object

org.ldp4j.application.vocabulary.AbstractImmutableVocabulary<T>

All Implemented Interfaces:

Serializable, Iterable<Term>, Vocabulary

Direct Known Subclasses:

LDP, RDF, RDFS

public abstract class AbstractImmutableVocabulary<T extends ImmutableTerm>
extends Object
implements Vocabulary

A base vocabulary implementation for creating immutable vocabularies that defines a collection of ImmutableTerms.
Purpose specific vocabularies should be implemented as follows:

 private static class CustomVocabulary extends
    AbstractImmutableVocabulary<ImmutableTerm> {

  private static final String NAMESPACE = "http://www.example.org/vocab";
  private static final String PREFERRED_PREFIX = "test";

  private static final String TERM_THREE = "termThree";
  private static final String TERM_TWO = "termTwo";
  private static final String TERM_ONE = "termOne";

  public CustomVocabulary() {
    super(ImmutableTerm.class, NAMESPACE, PREFERRED_PREFIX);
  }

  private static final CustomVocabulary VOCABULARY;
  private static final Term ONE;
  private static final Term TWO;
  private static final Term THREE;

  static {
    VOCABULARY = new CustomVocabulary();
    ONE = new ImmutableTerm(VOCABULARY, TERM_ONE);
    TWO = new ImmutableTerm(VOCABULARY, TERM_TWO);
    THREE = new ImmutableTerm(VOCABULARY, TERM_THREE);
    VOCABULARY.initialize();
  }
 }
 

Term related operations will fail with a IllegalStateException if they are used before the vocabulary is initialized properly.

Since:

1.0.0

Version:

1.0

Author:

Miguel Esteban Gutiérrez

See Also:

ImmutableTerm, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractImmutableVocabulary(Class<T> clazz, String namespace, String prefix) Create a new instance with a term class, a namespace, and a preferred prefix.

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.
UUID	getId() Get the unique identifier of the vocabulary.
String	getNamespace() Get the namespace of the vocabulary.
String	getPreferredPrefix() Get the preferred prefix for the vocabulary namespace.
Iterator<Term>	iterator()
int	size() Get the number of terms defined in the vocabulary.
T[]	terms() Get the terms defined in the vocabulary.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImmutableVocabulary

public AbstractImmutableVocabulary(Class<T> clazz,
                           String namespace,
                           String prefix)

Create a new instance with a term class, a namespace, and a preferred prefix.

Parameters:

clazz - the type of terms held by the vocabulary.

namespace - the namespace of the vocabulary.

prefix - the preferred prefix of the vocabulary.

Throws:

NullPointerException - if any of the parameters is null.

Method Detail

getId

public final UUID getId()

Get the unique identifier of the vocabulary.

Returns:

The identifier of the vocabulary.

See Also:

UUID

getNamespace

public final String getNamespace()

Get the namespace of the vocabulary.

Specified by:

getNamespace in interface Vocabulary

Returns:

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

getPreferredPrefix

public final String getPreferredPrefix()

Get the preferred prefix for the vocabulary namespace.

Specified by:

getPreferredPrefix in interface Vocabulary

Returns:

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

terms

public final T[] terms()

Get the terms defined in the vocabulary.

Specified by:

terms in interface Vocabulary

Returns:

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

size

public final int size()

Get the number of terms defined in the vocabulary.

Specified by:

size in interface Vocabulary

Returns:

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

fromName

public final 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.

Specified by:

fromName in interface Vocabulary

Parameters:

name - the name of the term to return

Returns:

the term of the vocabulary type with the specified name

fromOrdinal

public T fromOrdinal(int ordinal)

Returns the vocabulary term specified in a given position.

Specified by:

fromOrdinal in interface Vocabulary

Parameters:

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

Returns:

the term that was declared in the specified position.

fromValue

public final <V> T fromValue(V value)

Returns the vocabulary term that matches the specified value.

Specified by:

fromValue in interface Vocabulary

Parameters:

value - a value to determine the desired term.

Returns:

the term that upon transformation matches the specified value.

See Also:

Term.as(Class)

iterator

public final Iterator<Term> iterator()

Specified by:

iterator in interface Iterable<Term>