Interface AuthorityFactory

All Superinterfaces:

Factory

All Known Subinterfaces:

Coordinate­Operation­Authority­Factory, CRSAuthority­Factory, CSAuthority­Factory, Datum­Authority­Factory

All Known Implementing Classes:

Common­Authority­Factory, Concurrent­Authority­Factory, EPSGData­Access, EPSGFactory, Geodetic­Authority­Factory, Multi­Authorities­Factory, WKTDictionary

@UML(identifier="CS_CoordinateSystemAuthorityFactory",
     specification=OGC_01009)
public interface AuthorityFactory
extends Factory

Base interface for all authority factories. An authority is an organization that maintains definitions of authority codes. An authority code is a compact string defined by an authority to reference a particular spatial reference object. For example the European Petroleum Survey Group (EPSG) maintains a database of coordinate systems, and other spatial referencing objects, where each object has a code number ID. For example, the EPSG code for a WGS84 Lat/Lon coordinate system is '4326'.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
Identified­Object	create­Object(String code)	Returns an arbitrary object from a code.
Citation	get­Authority()	Returns the organization or party responsible for definition and maintenance of the database.
Set<String>	get­Authority­Codes(Class<? extends Identified­Object> type)	Returns the set of authority codes of the given type.
International­String	get­Description­Text(String code)	Gets a description of the object corresponding to a code.

Methods inherited from interface Factory

get­Vendor

Method Details

getAuthority

@UML(identifier="getAuthority",
     specification=OGC_01009)
Citation getAuthority()

Returns the organization or party responsible for definition and maintenance of the database.

Returns:

The organization responsible for definition of the database.

getAuthorityCodes

Set<String> getAuthorityCodes(Class<? extends IdentifiedObject> type)
                       throws FactoryException

Returns the set of authority codes of the given type. The type argument specifies the base class. For example if this factory is an instance of CRSAuthority­Factory, then:

• Coordinate­Reference­System.class asks for all authority codes accepted by one of create­Geographic­CRS, create­Projected­CRS, create­Vertical­CRS, create­Temporal­CRS and any other method returning a sub-type of Coordinate­Reference­System.
• Projected­CRS.class asks only for authority codes accepted by create­Projected­CRS.

Parameters:

type - The spatial reference objects type.

Returns:

The set of authority codes for spatial reference objects of the given type. If this factory doesn't contains any object of the given type, then this method returns an empty set.

Throws:

Factory­Exception - if access to the underlying database failed.

getDescriptionText

@UML(identifier="descriptionText",
     specification=OGC_01009)
InternationalString getDescriptionText(String code)
                                throws NoSuchAuthorityCodeException,
FactoryException

Gets a description of the object corresponding to a code.

Parameters:

code - Value allocated by authority.

Returns:

A description of the object, or null if the object corresponding to the specified code has no description.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the query failed for some other reason.

createObject

IdentifiedObject createObject(String code)
                       throws NoSuchAuthorityCodeException,
FactoryException

Returns an arbitrary object from a code. The returned object will typically be an instance of Datum, Coordinate­System, Reference­System or Coordinate­Operation. If the type of the object is know at compile time, it is recommended to invoke the most precise method instead of this one (for example create­Coordinate­Reference­System(code) instead of create­Object(code) if the caller know he is asking for a coordinate reference system).

Parameters:

code - Value allocated by authority.

Returns:

The object for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Datum­Authority­Factory.create­Datum(String)
• CRSAuthority­Factory.create­Coordinate­Reference­System(String)