Application: gvSIG desktop » gvSIG projections

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2018 gvSIG Association.

 * 

 * This file has been adapted from GeoAPI, see 

 * the original copyright headers bellow.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 * 

 * ----------

 * 

 *    GeoAPI - Java interfaces for OGC/ISO standards

 *    http://www.geoapi.org

 *

 *    Copyright (C) 2004-2017 Open Geospatial Consortium, Inc.

 *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal

 *

 *    Permission to use, copy, and modify this software and its documentation, with

 *    or without modification, for any purpose and without fee or royalty is hereby

 *    granted, provided that you include the following on ALL copies of the software

 *    and documentation or portions thereof, including modifications, that you make:

 *

 *    1. The full text of this NOTICE in a location viewable to users of the

 *       redistributed or derivative work.

 *    2. Notice of any changes or modifications to the OGC files, including the

 *       date changes were made.

 *

 *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE

 *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED

 *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT

 *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY

 *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

 *

 *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR

 *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.

 *

 *    The name and trademarks of copyright holders may NOT be used in advertising or

 *    publicity pertaining to the software without specific, written prior permission.

 *    Title to copyright in this software and any associated documentation will at all

 *    times remain with copyright holders.

 */

package org.gvsig.proj.catalogue;

import java.util.Set;

public interface IdentifiedObject {

    /**

     * An identifier which references elsewhere the object's defining information.

     * Alternatively an identifier by which this object can be referenced.

     *

     * @return this object identifiers, or an empty collection if there is none.

     */

    Set<String> getIdentifiers();

    /**

     * Gets the identifier which was used to instantiate the object, or the

     * identifier that more closely matches the information used to instantiate

     * the object (e.g. in case of dialect differences)

     */

    String getIdentifier();

    /**

     * Comments on or information about this object, including data source information.

     *

     * @return the remarks, or {@code null} if none.

     */

    String getRemarks();

    /**

     * Returns a <cite>Well-Known Text</cite> (WKT) for this object.

     * Well-Known Texts (WKT) may come in two formats:

     *

     * <ul>

     *   <li>The current standard, WKT 2, is defined by ISO 19162.</li>

     *   <li>The legacy format, WKT 1, was defined by {@linkplain org.opengis.annotation.Specification#OGC_01009 OGC 01-009}

     *       and is shown using Extended Backus Naur Form (EBNF) <a href="doc-files/WKT.html">here</a>.</li>

     * </ul>

     *

     * Implementations are encouraged to format according the most recent standard.

     * This operation may fail if unsupported or if this instance contains elements that do not have

     * WKT representation.

     *

     * @return the Well-Known Text (WKT) for this object.

     * @throws UnsupportedOperationException if this object can not be formatted as WKT.

     *

     * @departure extension

     *   This method is not part of the OGC specification. It has been added in order to provide

     *   the converse of the <code>CRSFactory.createFromWKT(String)</code> method, which is

     *   defined in OGC 01-009.

     *

     * @see org.opengis.referencing.crs.CRSFactory#createFromWKT(String)

     */

        String toWKT() throws UnsupportedOperationException;

}