Package org.biojavax

Class SimpleNamespace

  • All Implemented Interfaces:
    java.lang.Comparable, Changeable, Namespace
    public class SimpleNamespace
extends AbstractChangeable
implements Namespace
    A basic Namespace implemenation.
    Since:
    1.5
    Author:
    Richard Holland, Mark Schreiber

    • Constructor Detail

      • SimpleNamespace

        public SimpleNamespace​(java.lang.String name)
        Creates a new instance of SimpleNamespace with the given name, which cannot be null.
        Parameters:
        name - the name of the namespace.

      • SimpleNamespace

        protected SimpleNamespace()

    • Method Detail

      • setAcronym

        public 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.
        Specified by:
        setAcronym in interface Namespace
        Parameters:
        acronym - the acronym for the namespace.
        Throws:
        ChangeVetoException - in case of objections.

      • setAuthority

        public void setAuthority​(java.lang.String authority)
                  throws ChangeVetoException
        This method sets the authority that governs the namespace. Null will unset it.
        Specified by:
        setAuthority in interface Namespace
        Parameters:
        authority - the name of the namespace authority.
        Throws:
        ChangeVetoException - in case of objections.

      • setDescription

        public void setDescription​(java.lang.String description)
                    throws ChangeVetoException
        This method sets a description for the namespace. Null will unset it.
        Specified by:
        setDescription in interface Namespace
        Parameters:
        description - the description of the namespace.
        Throws:
        ChangeVetoException - in case of objections.

      • setURI

        public 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.
        Specified by:
        setURI in interface Namespace
        Parameters:
        URI - the URI of the authority.
        Throws:
        ChangeVetoException - in case of objections.

      • getAcronym

        public java.lang.String getAcronym()
        If the namespace has an acronym, this will return it.
        Specified by:
        getAcronym in interface Namespace
        Returns:
        the acronym for the namespace.

      • getAuthority

        public java.lang.String getAuthority()
        This method will return the authority that governs the namespace.
        Specified by:
        getAuthority in interface Namespace
        Returns:
        the name of the namespace authority.

      • getDescription

        public java.lang.String getDescription()
        Returns a description of this namespace.
        Specified by:
        getDescription in interface Namespace
        Returns:
        the description of the namespace.

      • getName

        public 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.
        Specified by:
        getName in interface Namespace
        Returns:
        The name of the namespace.

      • getURI

        public java.net.URI getURI()
        If the namespace has a URI, this will return it.
        Specified by:
        getURI in interface Namespace
        Returns:
        the URI of the authority.

      • compareTo

        public int compareTo​(java.lang.Object o)
        Namespaces are compared only by name.
        Specified by:
        compareTo in interface java.lang.Comparable

      • equals

        public boolean equals​(java.lang.Object obj)
        Namespaces are equal only by name.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Form: "name"
        Overrides:
        toString in class java.lang.Object

      • getId

        public java.lang.Integer getId()
        Gets the Hibernate ID. Should be used with caution.
        Returns:
        the Hibernate ID, if using Hibernate.

      • setId

        public void setId​(java.lang.Integer id)
        Sets the Hibernate ID. Should be used with caution.
        Parameters:
        id - the Hibernate ID, if using Hibernate.