Package org.biojavax
Interface Namespace
- All Superinterfaces:
Changeable
,Comparable
- All Known Implementing Classes:
SimpleNamespace
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ChangeType
static final ChangeType
static final ChangeType
static final ChangeType
static final ChangeType
-
Method Summary
Modifier and TypeMethodDescriptionIf the namespace has an acronym, this will return it.This method will return the authority that governs the namespace.Returns a description of this namespace.getName()
The name of the namespace is immutable and must be set by the constructor of the instantiating class.getURI()
If the namespace has a URI, this will return it.void
setAcronym
(String acronym) Sets an optional acronym for the namespace.void
setAuthority
(String authority) This method sets the authority that governs the namespace.void
setDescription
(String description) This method sets a description for the namespace.void
Sets an optional URI for the namespace.Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
NAME
-
AUTHORITY
-
DESCRIPTION
-
ACRONYM
-
URI
-
-
Method Details
-
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
This method will return the authority that governs the namespace.- Returns:
- the name of the namespace authority.
-
setAuthority
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
Returns a description of this namespace.- Returns:
- the description of the namespace.
-
setDescription
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
If the namespace has an acronym, this will return it.- Returns:
- the acronym for the namespace.
-
setAcronym
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
If the namespace has a URI, this will return it.- Returns:
- the URI of the authority.
-
setURI
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.
-