Package org.biojavax

Interface Namespace

All Superinterfaces:
Changeable, Comparable
All Known Implementing Classes:
SimpleNamespace

public interface Namespace extends 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:
  • Field Details

  • 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

      void setAuthority(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

      Returns a description of this namespace.
      Returns:
      the description of the namespace.
    • setDescription

      void setDescription(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

      If the namespace has an acronym, this will return it.
      Returns:
      the acronym for the namespace.
    • setAcronym

      void setAcronym(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

      If the namespace has a URI, this will return it.
      Returns:
      the URI of the authority.
    • setURI

      void setURI(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.