com.moximedia.aims.projection
Interface Projection

All Known Implementing Classes:

ProjectionAlbersEqualAreaConic, ProjectionGeographic, ProjectionLambertConformalConic2SP, ProjectionTransverseMercator, ProjectionUtm, ProjectionUtmAuto, ProjectionWKT

public interface Projection

Author:

jdc

Method Summary

java.lang.Object	clone() Returns a separate copy of this object.
boolean	equals(Projection anotherProjection) Returns an indicator of whether this projection is the same as another.
java.lang.String	getAlias() Return the alias of the projection
java.lang.String	getAlias(java.util.Locale locale) Return the alias of the projection
org.geotools.cs.CoordinateSystem	getCoordinateSystem() Method to compare projections.
java.lang.String	getMapCenterString(AimsPoint geoPoint, double scaleFactor) Returns the map center coordinate text.
java.lang.String	getName() Return the name of the projection
java.lang.String	getName(java.util.Locale locale) Return the name of the projection
double	getProjectionParameter(java.lang.String name) Gets the value of the specified projection parameter.
int	getProjectionType() Gets the projection type enumeration.
java.lang.String	getReportString(AimsPoint geoPoint, double scaleFactor) Returns the report for the standard identify reports.
java.lang.String	getSrs() Return the spatial reference system code.
int	getUnits() Return the map units of the projection.
java.lang.String	getUnitsString() Return the map units of the projection as a string.
boolean	isGeographicCoordinateSystem() Returns an indicator of whether this coordinate system is geographic.
boolean	isProjectedCoordinateSystem() Returns an indicator of whether this coordinate system is projected (non-geographic).
boolean	isValid() Gets an indicator of whether the projection is valid.
AimsPoint	project(AimsPoint point) Projects a geographic position into this projection.
void	setXmlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.
java.lang.String	toString() Displays the projection as a string.
java.lang.String	toWktString() Displays the projection parameters as a well known text string.
AimsPoint	unproject(AimsPoint point) Unprojects a projection position into geographic.

Method Detail

clone

public java.lang.Object clone()

Returns a separate copy of this object.

Returns:

A copy of this object as an Object.

equals

public boolean equals(Projection anotherProjection)

Returns an indicator of whether this projection is the same as another.

Parameters:

anotherProjection - The other projection.

Returns:

True if equal, otherwise false.

getAlias

public java.lang.String getAlias()

Return the alias of the projection

Returns:

The alias of the projection.

getAlias

public java.lang.String getAlias(java.util.Locale locale)

Return the alias of the projection

Parameters:

locale - The locale to format text and numbers.

Returns:

The alias of the projection.

getCoordinateSystem

public org.geotools.cs.CoordinateSystem getCoordinateSystem()

Method to compare projections.

Returns:

The geotools coordinate system backing this projection.

getMapCenterString

public java.lang.String getMapCenterString(AimsPoint geoPoint,
                                           double scaleFactor)

Returns the map center coordinate text.

Parameters:

geoPoint - A geographic point.

scaleFactor - The current map scale factor for use in rounding results.

Returns:

The report string.

getName

public java.lang.String getName()

Return the name of the projection

Returns:

The name of the projection.

getName

public java.lang.String getName(java.util.Locale locale)

Return the name of the projection

Parameters:

locale - The locale to format text and numbers.

Returns:

The name of the projection.

getReportString

public java.lang.String getReportString(AimsPoint geoPoint,
                                        double scaleFactor)

Returns the report for the standard identify reports.

Parameters:

geoPoint - A geographic point.

scaleFactor - The current map scale factor for use in rounding results.

Returns:

The report string.

getSrs

public java.lang.String getSrs()

Return the spatial reference system code.

Returns:

The spatial reference system code.

getUnits

public int getUnits()

Return the map units of the projection.

Returns:

The map units of the projection.

getUnitsString

public java.lang.String getUnitsString()

Return the map units of the projection as a string.

Returns:

The map units of the projection as a string.

isGeographicCoordinateSystem

public boolean isGeographicCoordinateSystem()

Returns an indicator of whether this coordinate system is geographic.

Returns:

True if it is geographic and valid, otherwise false.

isProjectedCoordinateSystem

public boolean isProjectedCoordinateSystem()

Returns an indicator of whether this coordinate system is projected (non-geographic).

Returns:

True if it is projected and valid, otherwise false.

isValid

public boolean isValid()

Gets an indicator of whether the projection is valid.

Returns:

True if valid, otherwise false.

project

public AimsPoint project(AimsPoint point)

Projects a geographic position into this projection. Note that this is a simple transformation without dataum shifts.

Parameters:

point - The geographic position.

Returns:

The projected position, or null if there is an error.

unproject

public AimsPoint unproject(AimsPoint point)

Unprojects a projection position into geographic. Note that this is a simple transformation without dataum shifts.

Parameters:

point - The projected position.

Returns:

The geographic position, or null if there is an error.

setXmlAttribute

public void setXmlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The XML element tag containing this attribute (not used).

name - The XML attribute name.

value - The XML attribute value.

toString

public java.lang.String toString()

Displays the projection as a string.

Returns:

The projection string.

toWktString

public java.lang.String toWktString()

Displays the projection parameters as a well known text string.

Returns:

The projection's well known text.

getProjectionType

public int getProjectionType()

Gets the projection type enumeration.

Returns:

The projection type enumeration.

getProjectionParameter

public double getProjectionParameter(java.lang.String name)

Gets the value of the specified projection parameter.

Returns:

The value, or Double.NaN if the parameter is not found or if the coordinate system is a Geographic Coordinate System.