/*$************************************************************************************************
**
** $Id: IdentifiedObject.java 831 2006-05-01 00:27:23Z Desruisseaux $
**
** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/referencing/IdentifiedObject.java $
**
** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
** All Rights Reserved. http://www.opengis.org/legal/
**
*************************************************************************************************/
package org.opengis.referencing;
// J2SE direct dependencies
import java.util.Set;
import java.util.Collection;
// OpenGIS direct dependencies
import org.opengis.metadata.Identifier;
import org.opengis.util.GenericName;
import org.opengis.util.InternationalString;
// Annotations
import org.opengis.annotation.UML;
import org.opengis.annotation.Extension;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;
/**
* Supplementary identification and remarks information for a CRS or CRS-related object.
* When {@link org.opengis.referencing.crs.CRSAuthorityFactory} is used to create an object,
* the {@linkplain Identifier#getAuthority authority} and {@linkplain Identifier#getCode
* authority code} values should be set to the authority name of the factory object,
* and the authority code supplied by the client, respectively. The other values may
* or may not be set. If the authority is EPSG, the implementer may consider using the
* corresponding metadata values in the EPSG tables.
*
* @version Abstract specification 2.0
* @author ISO/DIS 19111
* @author Martin Desruisseaux (IRD)
* @since GeoAPI 2.0
*/
@UML(identifier="IdentifiedObject", specification=ISO_19111)
public interface IdentifiedObject {
/**
* Key for the {@value} property to be given to the
* {@linkplain ObjectFactory object factory} createFoo(…) methods.
* This is used for setting the value to be returned by {@link #getName}.
*
* @see #getName
*/
String NAME_KEY = "name";
/**
* Key for the {@value} property to be given to the
* {@linkplain ObjectFactory object factory} createFoo(…) methods.
* This is used for setting the value to be returned by {@link #getAlias}.
*
* @see #getAlias
*/
String ALIAS_KEY = "alias";
/**
* Key for the {@value} property to be given to the
* {@linkplain ObjectFactory object factory} createFoo(…) methods.
* This is used for setting the value to be returned by {@link #getIdentifiers}.
*
* @see #getIdentifiers
*/
String IDENTIFIERS_KEY = "identifiers";
/**
* Key for the {@value} property to be given to the
* {@linkplain ObjectFactory object factory} createFoo(…) methods.
* This is used for setting the value to be returned by {@link #getRemarks}.
*
* @see #getRemarks
*/
String REMARKS_KEY = "remarks";
/**
* The primary name by which this object is identified.
*/
@UML(identifier="name", obligation=MANDATORY, specification=ISO_19111)
Identifier getName();
/**
* An alternative name by which this object is identified.
*
* @return The aliases, or an empty collection if there is none.
*/
@UML(identifier="alias", obligation=OPTIONAL, specification=ISO_19111)
Collection getAlias();
/**
* 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 set if there is none.
*/
@UML(identifier="identifier", obligation=OPTIONAL, specification=ISO_19111)
Set getIdentifiers();
/**
* Comments on or information about this object, including data source information.
*/
@UML(identifier="remarks", obligation=OPTIONAL, specification=ISO_19111)
InternationalString getRemarks();
/**
* Returns a Well Known Text (WKT) for this object.
* This operation may fails if an object is too complex for the WKT format capability (for
* example an {@linkplain org.opengis.referencing.crs.EngineeringCRS engineering CRS} with
* different unit for each axis).
*
* @return The Well Know Text for this object.
* @throws UnsupportedOperationException If this object can't be formatted as WKT.
*/
@Extension
String toWKT() throws UnsupportedOperationException;
}
Ads help maintain this website.