|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@UML(identifier="CS_CoordinateSystemAuthorityFactory", specification=OGC_01009) public interface AuthorityFactory
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'.
Method Summary | |
---|---|
IdentifiedObject |
createObject(String code)
Returns an arbitrary object from a code. |
Citation |
getAuthority()
Returns the organization or party responsible for definition and maintenance of the database. |
Set<String> |
getAuthorityCodes(Class<? extends IdentifiedObject> type)
Returns the set of authority codes of the given type. |
InternationalString |
getDescriptionText(String code)
Gets a description of the object corresponding to a code. |
Methods inherited from interface Factory |
---|
getVendor |
Method Detail |
---|
@UML(identifier="getAuthority", specification=OGC_01009) Citation getAuthority()
Set<String> getAuthorityCodes(Class<? extends IdentifiedObject> type) throws FactoryException
type
argument specifies the base class. For example if this factory is an instance
of CRSAuthorityFactory
, then:
CoordinateReferenceSystem.class
asks for all authority codes accepted by one of
createGeographicCRS
,
createProjectedCRS
,
createVerticalCRS
,
createTemporalCRS
and any other method returning a sub-type of CoordinateReferenceSystem
.ProjectedCRS.class
asks only for authority codes accepted by
createProjectedCRS
.
type
- The spatial reference objects type.
FactoryException
- if access to the underlying database failed.Departure from OGC/ISO specification:
This method is not part of the OGC specification but has been added as a way to publish the capabilities of a factory.
@UML(identifier="descriptionText", specification=OGC_01009) InternationalString getDescriptionText(String code) throws NoSuchAuthorityCodeException, FactoryException
code
- Value allocated by authority.
null
if the object
corresponding to the specified code
has no description.
NoSuchAuthorityCodeException
- if the specified code
was not found.
FactoryException
- if the query failed for some other reason.IdentifiedObject createObject(String code) throws NoSuchAuthorityCodeException, FactoryException
Datum
, CoordinateSystem
,
ReferenceSystem
or CoordinateOperation
.
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
createCoordinateReferenceSystem(code)
instead of createObject(code)
if the caller know he is asking for a coordinate
reference system).
code
- Value allocated by authority.
NoSuchAuthorityCodeException
- if the specified code
was not found.
FactoryException
- if the object creation failed for some other reason.DatumAuthorityFactory.createDatum(String)
,
CRSAuthorityFactory.createCoordinateReferenceSystem(String)
Departure from OGC/ISO specification:
This method is not part of the OGC specification. It has been added to leverage the capability of factories that can automatically determine the type of the requested object at runtime.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |