ilog.views.maps.srs.coordsys

Class IlvCoordinateSystem

java.lang.Object

ilog.views.maps.srs.coordsys.IlvCoordinateSystem

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvGeocentricCoordinateSystem, IlvGeographicCoordinateSystem, IlvProjectedCoordinateSystem

public abstract class IlvCoordinateSystem
extends Object
implements IlvPersistentObject

The interface defining the coordinate systems.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvCoordinateSystem(IlvCoordinateSystem source) Constructs a new IlvCoordinateSystem by copying an existing one.
protected	IlvCoordinateSystem(IlvInputStream stream) Reads the object from an IlvInputStream object.
protected	IlvCoordinateSystem(String name, IlvUnit[] units, String[] axisNames) Constructs a new IlvCoordinateSystem.

Method Summary

Modifier and Type	Method and Description
abstract IlvCoordinateSystem	copy() Returns a copy of this coordinate system.
boolean	equals(Object other) Returns true if this coordinate system is equal to the specified coordinate system.
String	getAxisName(int dimension) Returns the name of the axis which index is specified.
int	getDimension() Returns the dimension of this coordinate system.
String	getName() Returns the name of the coordinate system.
IlvUnit	getUnit(int dimension) Returns the units of this coordinate system.
String	toString(IlvCoordinate p) Creates a string representation of the IlvCoordinate argument.
void	write(IlvOutputStream stream) Writes the object to the specified IlvOutputStream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvCoordinateSystem

protected IlvCoordinateSystem(String name,
                              IlvUnit[] units,
                              String[] axisNames)

Constructs a new IlvCoordinateSystem. The dimension of coordinates in this coordinate system is defined by the number of elements in the units[] parameter.

Parameters:

name - The name of the coordinate system.

units - The units of the coordinate system.

axisNames - The names of the axis in this coordinate system.

IlvCoordinateSystem

protected IlvCoordinateSystem(IlvCoordinateSystem source)

Constructs a new IlvCoordinateSystem by copying an existing one.

Parameters:

source - The source coordinate system.

IlvCoordinateSystem

protected IlvCoordinateSystem(IlvInputStream stream)
                       throws IlvReadFileException

Reads the object from an IlvInputStream object.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - If the format is not correct.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to the specified IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The stream to write this unit to.

Throws:

IOException - If an I/O error occurs.

copy

public abstract IlvCoordinateSystem copy()

Returns a copy of this coordinate system.

getName

public String getName()

Returns the name of the coordinate system.

getDimension

public int getDimension()

Returns the dimension of this coordinate system.

getUnit

public IlvUnit getUnit(int dimension)

Returns the units of this coordinate system.

getAxisName

public String getAxisName(int dimension)

Returns the name of the axis which index is specified.

equals

public boolean equals(Object other)

Returns true if this coordinate system is equal to the specified coordinate system. The default implementation will compare coordinate system names, dimension, units, and axis names.

Overrides:

equals in class Object

toString

public String toString(IlvCoordinate p)

Creates a string representation of the IlvCoordinate argument.

Parameters:

p - The coordinate to be converted.

Returns:

A string representation of the argument.