ilog.views.maps.projection
Class IlvEllipsoidCollection

java.lang.Object
  extended by ilog.views.maps.projection.IlvEllipsoidCollection
All Implemented Interfaces:
Serializable

public class IlvEllipsoidCollection
extends Object
implements Serializable

This class manages a collection of named ellipsoids.

Since:
JViews 5.0
See Also:
Serialized Form

Constructor Summary
IlvEllipsoidCollection(InputStream stream)
          Creates a new collection of ellipsoids, reading data from the specified input stream.
IlvEllipsoidCollection(String filename)
          Creates a new collection of ellipsoids, reading data from the file which name is specified.
 
Method Summary
 IlvEllipsoid getEllipsoid(String name)
          Returns the ellipsoid of specified name if present in the collection.
 Iterator getEllipsoids()
          Returns the enumeration of ellipsoids.
static IlvEllipsoidCollection GetKernelCollection()
          Returns a collection containing the definition of all ellipsoids supported by ILOG JViews Maps.
static IlvEllipsoidCollection Merge(IlvEllipsoidCollection collection1, IlvEllipsoidCollection collection2)
          Merge the specified ellipsoid collections.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IlvEllipsoidCollection

public IlvEllipsoidCollection(String filename)
                       throws IOException,
                              IlvCollectionParseException
Creates a new collection of ellipsoids, reading data from the file which name is specified. All ellipsoids from the file are loaded at construction time and cached in the collection.

Parameters:
filename - The name of the input file.
Throws:
IOException - If an I/O error occurs.
IlvCollectionParseException - If an error occurs during the parsing of the definition file.

IlvEllipsoidCollection

public IlvEllipsoidCollection(InputStream stream)
                       throws IOException,
                              IlvCollectionParseException
Creates a new collection of ellipsoids, reading data from the specified input stream. All ellipsoids from the file are loaded at construction time and cached in the collection.

Parameters:
stream - The input stream.
Throws:
IOException - If an I/O error occurs.
IlvCollectionParseException - If an error occurs during the parsing of the definition file.
Method Detail

getEllipsoids

public final Iterator getEllipsoids()
Returns the enumeration of ellipsoids. The elements of the enumeration are instances of IlvEllipsoid.

Returns:
An iterator on all ellipsoids defined in this collection.
See Also:
Iterator

getEllipsoid

public final IlvEllipsoid getEllipsoid(String name)
Returns the ellipsoid of specified name if present in the collection. Returns null if the ellipsoid isn't in the collection

Parameters:
name - The name of the ellipsoid.
Returns:
The ellipsoid, or null if not found.

GetKernelCollection

public static IlvEllipsoidCollection GetKernelCollection()
Returns a collection containing the definition of all ellipsoids supported by ILOG JViews Maps.

Returns:
An IlvEllipsoidCollection containing all default ellipsoids definitions.

Merge

public static IlvEllipsoidCollection Merge(IlvEllipsoidCollection collection1,
                                           IlvEllipsoidCollection collection2)
Merge the specified ellipsoid collections.

Parameters:
collection1 - The first ellipsoid collection.
collection2 - The second ellipsoid collection.
Returns:
The merged ellipsoid collection.


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.