org.biojavax

Interface Namespace

All Superinterfaces:

Changeable, java.lang.Comparable

All Known Implementing Classes:

SimpleNamespace

public interface Namespace
extends java.lang.Comparable, Changeable

The namespace of an entry in a database schema. Relates directly to the BioDatabase table in BioSQL. All BioEntry objects belong to namespaces.

Since:

1.5

Author:

Mark Schreiber, Richard Holland

See Also:

BioEntry

Field Summary

Fields

Modifier and Type	Field and Description
static ChangeType	ACRONYM
static ChangeType	AUTHORITY
static ChangeType	DESCRIPTION
static ChangeType	NAME
static ChangeType	URI

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcronym() If the namespace has an acronym, this will return it.
java.lang.String	getAuthority() This method will return the authority that governs the namespace.
java.lang.String	getDescription() Returns a description of this namespace.
java.lang.String	getName() The name of the namespace is immutable and must be set by the constructor of the instantiating class.
java.net.URI	getURI() If the namespace has a URI, this will return it.
void	setAcronym(java.lang.String acronym) Sets an optional acronym for the namespace.
void	setAuthority(java.lang.String authority) This method sets the authority that governs the namespace.
void	setDescription(java.lang.String description) This method sets a description for the namespace.
void	setURI(java.net.URI URI) Sets an optional URI for the namespace.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.biojava.utils.Changeable

addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener

Field Detail

NAME

static final ChangeType NAME

AUTHORITY

static final ChangeType AUTHORITY

DESCRIPTION

static final ChangeType DESCRIPTION

ACRONYM

static final ChangeType ACRONYM

URI

static final ChangeType URI

Method Detail

getName

java.lang.String getName()

The name of the namespace is immutable and must be set by the constructor of the instantiating class. The name should also be unique. This method will return the name.

Returns:

The name of the namespace.

getAuthority

java.lang.String getAuthority()

This method will return the authority that governs the namespace.

Returns:

the name of the namespace authority.

setAuthority

void setAuthority(java.lang.String authority)
                  throws ChangeVetoException

This method sets the authority that governs the namespace. Null will unset it.

Parameters:

authority - the name of the namespace authority.

Throws:

ChangeVetoException - in case of objections.

getDescription

java.lang.String getDescription()

Returns a description of this namespace.

Returns:

the description of the namespace.

setDescription

void setDescription(java.lang.String description)
                    throws ChangeVetoException

This method sets a description for the namespace. Null will unset it.

Parameters:

description - the description of the namespace.

Throws:

ChangeVetoException - in case of objections.

getAcronym

java.lang.String getAcronym()

If the namespace has an acronym, this will return it.

Returns:

the acronym for the namespace.

setAcronym

void setAcronym(java.lang.String acronym)
                throws ChangeVetoException

Sets an optional acronym for the namespace. Null will unset it. Note that in BioSQL 1.0 Acronym is only part of the Oracle schema therefore it will only be persisted in that schema.

Parameters:

acronym - the acronym for the namespace.

Throws:

ChangeVetoException - in case of objections.

getURI

java.net.URI getURI()

If the namespace has a URI, this will return it.

Returns:

the URI of the authority.

setURI

void setURI(java.net.URI URI)
            throws ChangeVetoException

Sets an optional URI for the namespace. Null will unset it. Note that in BioSQL 1.0 URI is not persisted into the database unless the extended Oracle schema is used.

Parameters:

URI - the URI of the authority.

Throws:

ChangeVetoException - in case of objections.