Package org.locationtech.proj4j.geoapi

Class SimpleCitation

  • All Implemented Interfaces:
    java.io.Serializable, org.opengis.metadata.citation.Citation, org.opengis.metadata.citation.Contact, org.opengis.metadata.citation.OnlineResource, org.opengis.metadata.citation.ResponsibleParty
    final class SimpleCitation
extends java.lang.Object
implements org.opengis.metadata.citation.Citation, org.opengis.metadata.citation.ResponsibleParty, org.opengis.metadata.citation.Contact, org.opengis.metadata.citation.OnlineResource, java.io.Serializable
    A citation containing only a title, an organization name and a URL. This implementation merges many interfaces in a single class for convenience.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String organization
      The organization responsible for the maintenance of the dataset or project.
      (package private) static SimpleCitation PROJ4J
      The citation for the PROJ4J software.
      private java.lang.String title
      The title of the dataset or project.
      private java.lang.String url
      URL where user can get more information.
      private java.lang.String urlName
      Name of the page referenced by url.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private SimpleCitation​(java.lang.String title, java.lang.String organization, java.lang.String urlName, java.lang.String url)
      Creates a new citation with the given title.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.opengis.metadata.citation.Address getAddress()  
      java.util.Collection<org.opengis.util.InternationalString> getAlternateTitles()  
      java.lang.String getApplicationProfile()  
      java.util.Collection<org.opengis.metadata.citation.ResponsibleParty> getCitedResponsibleParties()
      {@return the organization together with other information such as the organization role}.
      org.opengis.util.InternationalString getCollectiveTitle()  
      org.opengis.metadata.citation.Contact getContactInfo()
      {@return information for contacting the responsible party}.
      org.opengis.util.InternationalString getContactInstructions()  
      java.util.Collection<org.opengis.metadata.citation.CitationDate> getDates()  
      org.opengis.util.InternationalString getDescription()  
      org.opengis.util.InternationalString getEdition()  
      java.util.Date getEditionDate()  
      org.opengis.metadata.citation.OnLineFunction getFunction()
      {@return the purpose of the linkage}.
      org.opengis.util.InternationalString getHoursOfService()  
      java.util.Collection<org.opengis.metadata.Identifier> getIdentifiers()  
      java.lang.String getIndividualName()  
      java.lang.String getISBN()  
      java.lang.String getISSN()  
      java.net.URI getLinkage()
      {@return URL to the organization web site}.
      java.lang.String getName()
      {@return name of the online resource}.
      org.opengis.metadata.citation.OnlineResource getOnlineResource()
      {@return information about how to contact the organization}.
      org.opengis.util.InternationalString getOrganisationName()
      {@return the organization responsible for the maintenance of the dataset or project}.
      org.opengis.util.InternationalString getOtherCitationDetails()  
      org.opengis.metadata.citation.Telephone getPhone()  
      org.opengis.util.InternationalString getPositionName()  
      java.util.Collection<org.opengis.metadata.citation.PresentationForm> getPresentationForms()
      {@return a description of how the dataset or project is presented}.
      java.lang.String getProtocol()  
      org.opengis.metadata.citation.Role getRole()
      {@return the role of the organization regarding the software or data}.
      org.opengis.metadata.citation.Series getSeries()  
      org.opengis.util.InternationalString getTitle()
      {@return the title of the dataset or project}.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PROJ4J

        static final SimpleCitation PROJ4J
        The citation for the PROJ4J software.

      • title

        private final java.lang.String title
        The title of the dataset or project.
        See Also:
        getTitle()

      • urlName

        private final java.lang.String urlName
        Name of the page referenced by url.

      • url

        private final java.lang.String url
        URL where user can get more information.

    • Constructor Detail

      • SimpleCitation

        private SimpleCitation​(java.lang.String title,
                       java.lang.String organization,
                       java.lang.String urlName,
                       java.lang.String url)
        Creates a new citation with the given title.

    • Method Detail

      • getTitle

        public org.opengis.util.InternationalString getTitle()
        {@return the title of the dataset or project}. Examples: "EPSG", "PROJ4J".
        Specified by:
        getTitle in interface org.opengis.metadata.citation.Citation

      • getPresentationForms

        public java.util.Collection<org.opengis.metadata.citation.PresentationForm> getPresentationForms()
        {@return a description of how the dataset or project is presented}.
        Specified by:
        getPresentationForms in interface org.opengis.metadata.citation.Citation

      • getCitedResponsibleParties

        public java.util.Collection<org.opengis.metadata.citation.ResponsibleParty> getCitedResponsibleParties()
        {@return the organization together with other information such as the organization role}. This is the method invoked by users for accessing getOrganisationName().
        Specified by:
        getCitedResponsibleParties in interface org.opengis.metadata.citation.Citation

      • getOrganisationName

        public org.opengis.util.InternationalString getOrganisationName()
        {@return the organization responsible for the maintenance of the dataset or project}. Examples: "IOGP", "Eclipse".
        Specified by:
        getOrganisationName in interface org.opengis.metadata.citation.ResponsibleParty

      • getRole

        public org.opengis.metadata.citation.Role getRole()
        {@return the role of the organization regarding the software or data}.
        Specified by:
        getRole in interface org.opengis.metadata.citation.ResponsibleParty

      • getContactInfo

        public org.opengis.metadata.citation.Contact getContactInfo()
        {@return information for contacting the responsible party}.
        Specified by:
        getContactInfo in interface org.opengis.metadata.citation.ResponsibleParty

      • getOnlineResource

        public org.opengis.metadata.citation.OnlineResource getOnlineResource()
        {@return information about how to contact the organization}. Note that this is a member of contact information, not project information.

        Note: for providing a link to the project instead of the organization, we need to wait for the release of GeoAPI 3.1.

        Specified by:
        getOnlineResource in interface org.opengis.metadata.citation.Contact

      • getName

        public java.lang.String getName()
        {@return name of the online resource}. It describes the content of getLinkage(), which is about the organization, not the project.
        Specified by:
        getName in interface org.opengis.metadata.citation.OnlineResource

      • getLinkage

        public java.net.URI getLinkage()
        {@return URL to the organization web site}. Note that this is a member of contact information, not project information.
        Specified by:
        getLinkage in interface org.opengis.metadata.citation.OnlineResource

      • getFunction

        public org.opengis.metadata.citation.OnLineFunction getFunction()
        {@return the purpose of the linkage}.
        Specified by:
        getFunction in interface org.opengis.metadata.citation.OnlineResource

      • getAlternateTitles

        public java.util.Collection<org.opengis.util.InternationalString> getAlternateTitles()
        Specified by:
        getAlternateTitles in interface org.opengis.metadata.citation.Citation

      • getCollectiveTitle

        public org.opengis.util.InternationalString getCollectiveTitle()
        Specified by:
        getCollectiveTitle in interface org.opengis.metadata.citation.Citation

      • getDates

        public java.util.Collection<org.opengis.metadata.citation.CitationDate> getDates()
        Specified by:
        getDates in interface org.opengis.metadata.citation.Citation

      • getEditionDate

        public java.util.Date getEditionDate()
        Specified by:
        getEditionDate in interface org.opengis.metadata.citation.Citation

      • getEdition

        public org.opengis.util.InternationalString getEdition()
        Specified by:
        getEdition in interface org.opengis.metadata.citation.Citation

      • getSeries

        public org.opengis.metadata.citation.Series getSeries()
        Specified by:
        getSeries in interface org.opengis.metadata.citation.Citation

      • getOtherCitationDetails

        public org.opengis.util.InternationalString getOtherCitationDetails()
        Specified by:
        getOtherCitationDetails in interface org.opengis.metadata.citation.Citation

      • getISBN

        public java.lang.String getISBN()
        Specified by:
        getISBN in interface org.opengis.metadata.citation.Citation

      • getISSN

        public java.lang.String getISSN()
        Specified by:
        getISSN in interface org.opengis.metadata.citation.Citation

      • getIndividualName

        public java.lang.String getIndividualName()
        Specified by:
        getIndividualName in interface org.opengis.metadata.citation.ResponsibleParty

      • getPositionName

        public org.opengis.util.InternationalString getPositionName()
        Specified by:
        getPositionName in interface org.opengis.metadata.citation.ResponsibleParty

      • getPhone

        public org.opengis.metadata.citation.Telephone getPhone()
        Specified by:
        getPhone in interface org.opengis.metadata.citation.Contact

      • getAddress

        public org.opengis.metadata.citation.Address getAddress()
        Specified by:
        getAddress in interface org.opengis.metadata.citation.Contact

      • getHoursOfService

        public org.opengis.util.InternationalString getHoursOfService()
        Specified by:
        getHoursOfService in interface org.opengis.metadata.citation.Contact

      • getContactInstructions

        public org.opengis.util.InternationalString getContactInstructions()
        Specified by:
        getContactInstructions in interface org.opengis.metadata.citation.Contact

      • getProtocol

        public java.lang.String getProtocol()
        Specified by:
        getProtocol in interface org.opengis.metadata.citation.OnlineResource

      • getApplicationProfile

        public java.lang.String getApplicationProfile()
        Specified by:
        getApplicationProfile in interface org.opengis.metadata.citation.OnlineResource

      • getDescription

        public org.opengis.util.InternationalString getDescription()
        Specified by:
        getDescription in interface org.opengis.metadata.citation.OnlineResource

      • getIdentifiers

        public java.util.Collection<org.opengis.metadata.Identifier> getIdentifiers()
        Specified by:
        getIdentifiers in interface org.opengis.metadata.citation.Citation