/*$************************************************************************************************
 **
 ** $Id: ObjectFactory.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/ObjectFactory.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.referencing;

// OpenGIS dependencies
import org.opengis.metadata.Identifier;
import org.opengis.metadata.citation.Citation;
import org.opengis.util.InternationalString;
import org.opengis.util.GenericName;

// Annotations
import org.opengis.annotation.Extension;


/**
 * Base interface for all factories of {@linkplain IdentifiedObject identified objects}. Factories
 * build up complex objects from simpler objects or values. This factory allows applications
 * to make {@linkplain org.opengis.referencing.cs.CoordinateSystem coordinate systems},
 * {@linkplain org.opengis.referencing.datum.Datum datum} or
 * {@linkplain org.opengis.referencing.crs.CoordinateReferenceSystem coordinate reference systems}
 * that cannot be created by an {@linkplain AuthorityFactory authority factory}. This factory is
 * very flexible, whereas the authority factory is easier to use.
 * 

*

Object properties

*

Most factory methods expect a {@link java.util.Map} argument. The map is often (but is not required * to be) a {@link java.util.Properties} instance. The map shall contains at least a "name" * property. In the common case where the name is the only property, the map may be constructed with * Collections.{@linkplain java.util.Collections#singletonMap singletonMap}("name", * theName) where theName is an arbitrary name as free text. * Additionally, implementations are encouraged to recognize at least the properties listed * in the following table. More implementation-specific properties may be added as well. * In any case, unknown properties will be ignored.

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Property nameValue typeValue given to
 {@value org.opengis.referencing.IdentifiedObject#NAME_KEY}  {@link Identifier} or {@link String}  {@link IdentifiedObject#getName}
 {@value org.opengis.referencing.IdentifiedObject#ALIAS_KEY}  {@link String}, {@linkplain String}[], * {@link GenericName} or {@linkplain GenericName}[]  {@link IdentifiedObject#getAlias}
 {@value org.opengis.metadata.Identifier#AUTHORITY_KEY}  {@link String} or {@link Citation}  {@link Identifier#getAuthority} on the {@linkplain IdentifiedObject#getName name}
 {@value org.opengis.metadata.Identifier#VERSION_KEY}  {@link String}  {@link Identifier#getVersion} on the {@linkplain IdentifiedObject#getName name}
 {@value org.opengis.referencing.IdentifiedObject#IDENTIFIERS_KEY}  {@link Identifier} or {@linkplain Identifier}[]  {@link IdentifiedObject#getIdentifiers}
 {@value org.opengis.referencing.IdentifiedObject#REMARKS_KEY}  {@link String} or {@link InternationalString}  {@link IdentifiedObject#getRemarks}
* *

The "name" property is mandatory. All others are optional. Additionally, all * localizable attributes like "remarks" may have a language and country code suffix. * For example the "remarks_fr" property stands for remarks in * {@linkplain java.util.Locale#FRENCH French} and the "remarks_fr_CA" property * stands for remarks in {@linkplain java.util.Locale#CANADA_FRENCH French Canadian}.

* * @version Implementation specification 1.0 * @author Open Geospatial Consortium * @author Martin Desruisseaux (IRD) * @since GeoAPI 2.0 */ @Extension public interface ObjectFactory extends Factory { }

Ads help maintain this website.