Package org.gedcomx.common

Class Qualifier

java.lang.Object

org.gedcomx.common.Qualifier

public final class Qualifier
extends Object

A data qualifier. Qualifiers are used to "qualify" certain data elements to provide additional context, information, or details.

Author:

Ryan Heaton

Constructor Summary

Constructors

Constructor	Description
Qualifier()
Qualifier(URI name)
Qualifier(URI name, String value)
Qualifier(ControlledVocabulary name)
Qualifier(ControlledVocabulary name, String value)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
URI	getName()	The name of the qualifier.
String	getValue()	The value of the qualifier.
int	hashCode()
Qualifier	name(URI name)	Build up this qualifier with a name.
Qualifier	name(ControlledVocabulary name)	Build up this qualifier with a name.
void	setName(URI name)	The name of the qualifier.
void	setName(ControlledVocabulary element)	Set the qualifier name as an element of a constrained vocabulary.
void	setValue(String value)	The value of the qualifier.
String	toString()
Qualifier	value(String value)	Build up this qualifier with a value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Qualifier

public Qualifier()

Qualifier

public Qualifier(URI name,
                 String value)

Qualifier

public Qualifier(URI name)

Qualifier

public Qualifier(ControlledVocabulary name,
                 String value)

Qualifier

public Qualifier(ControlledVocabulary name)

Method Detail

getName

public URI getName()

The name of the qualifier. The name should be an element of a constrained vocabulary and is used to determine meaning of the qualifier.

Returns:

The name of the qualifier.

setName

public void setName(URI name)

The name of the qualifier. The name should be an element of a constrained vocabulary and is used to determine meaning of the qualifier.

Parameters:

name - The name of the qualifier.

name

public Qualifier name(URI name)

Build up this qualifier with a name.

Parameters:

name - the name.

Returns:

this.

setName

public void setName(ControlledVocabulary element)

Set the qualifier name as an element of a constrained vocabulary.

Parameters:

element - The element.

name

public Qualifier name(ControlledVocabulary name)

Build up this qualifier with a name.

Parameters:

name - the name.

Returns:

this.

getValue

public String getValue()

The value of the qualifier. Some qualifiers may not have values, indicating that the qualifier is to be treated more like a "tag".

Returns:

The value of the qualifier.

setValue

public void setValue(String value)

The value of the qualifier. Some qualifiers may not have values, indicating that the qualifier is to be treated more like a "tag".

Parameters:

value - The value of the qualifier.

value

public Qualifier value(String value)

Build up this qualifier with a value.

Parameters:

value - The value of the qualifier.

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object