com.partnersoft.maps.rover
Interface RoverLayer

All Superinterfaces:

Identifiable

All Known Implementing Classes:

AbstractRoverLayer

public interface RoverLayer
extends Identifiable

An independent layer of map data and shapes.

RoverLayers are a container for RoverEntities, their contents, and the various indices and supporting types. Multiple RoverLayers are stacked to form the full contents of a map view.

RoverLayers are a more heavyweight abstraction than layers in CAD systems such as AutoCAD. What those systems call a "layer" is more analogous to a what we call a RoverDrawable.

RoverLayers were referred to as RoverSets in versions 4.4 and earlier of the Partner Platform.

Copyright 2008-2009 Partner Software, Inc.

Version:

$Id$

Author:

Paul Reavis

Method Summary

RoverDrawable	drawableFor(int drawId) Returns the RoverDrawable with the given integer ID.
RoverDrawable	drawableNamed(java.lang.String drawName) Returns the RoverDraw with the given name.
RoverEntity	entityFor(int dataTypeId) Returns the RoverEntity with the given ID.
RoverCoordinateSystem	getCoordinateSystem() Coordinate system of map shape points.
RoverLevelOfDetail	levelOfDetailFor(int lodId) Returns the level of detail for the given ID.
java.util.List<RoverDrawable>	listDrawables() Lists all RoverDrawable definitions for this map.
java.util.List<RoverEntity>	listEntities() Lists all entities in the map.
java.util.List<RoverStringIndex>	listFindIndices() Returns the available find indices for this map.
java.util.List<RoverLevelOfDetail>	listLevelsOfDetail() Lists all levels of detail in the map.
java.util.List<RoverBytes>	listStreamsFor(int lodId, XyBounds bounds) Returns the graphic streams required to render the given area.
java.util.List<RoverType>	listTypes() Lists all RoverType definitions for this map.
Naming<RoverDrawable>	nameDrawables() Returns all RoverDrawable definitions for this map as a Naming.
Naming<RoverStringIndex>	nameFindIndices() Returns the available find indices for this map as a naming.
Naming<RoverType>	nameTypes() Returns all RoverType definitions for this layer as a Naming.
RoverType	typeFor(int typeId) Returns the RoverType with the given integer ID.
RoverType	typeNamed(java.lang.String typeName) Returns the RoverType with the given name.

Methods inherited from interface com.partnersoft.core.Identifiable

getGuid, getId, getName

Method Detail

getCoordinateSystem

RoverCoordinateSystem getCoordinateSystem()

Coordinate system of map shape points.

nameTypes

Naming<RoverType> nameTypes()

Returns all RoverType definitions for this layer as a Naming.

Returns:

naming of data types

listTypes

java.util.List<RoverType> listTypes()

Lists all RoverType definitions for this map.

Returns:

immutable list of RoverTypes for this map

typeFor

RoverType typeFor(int typeId)

Returns the RoverType with the given integer ID.

Parameters:

typeId - ID for desired RoverType

Returns:

data type requested, null if none corresponding to ID

typeNamed

RoverType typeNamed(java.lang.String typeName)

Returns the RoverType with the given name.

Parameters:

typeName - name of desired RoverType

Returns:

data type requested, null if none corresponding to name

nameDrawables

Naming<RoverDrawable> nameDrawables()

Returns all RoverDrawable definitions for this map as a Naming.

Returns:

naming of draw types

listDrawables

java.util.List<RoverDrawable> listDrawables()

Lists all RoverDrawable definitions for this map.

Returns:

immutable list of RoverDrawables for this map

drawableFor

RoverDrawable drawableFor(int drawId)

Returns the RoverDrawable with the given integer ID.

Parameters:

drawId - ID for desired RoverDrawable

Returns:

draw requested, null if none corresponding to ID

drawableNamed

RoverDrawable drawableNamed(java.lang.String drawName)

Returns the RoverDraw with the given name.

Parameters:

drawName - name of desired RoverDraw

Returns:

draw requested, null if none corresponding to name

entityFor

RoverEntity entityFor(int dataTypeId)

Returns the RoverEntity with the given ID.

Returns:

entity requested, null if none corresponding to ID

listEntities

java.util.List<RoverEntity> listEntities()

Lists all entities in the map. Beware, this may be a VERY long list, and you should avoid copying it. Also, it may become invalid if the map is refreshed or retranslated.

Returns:

immutable list of all entities in the map

listLevelsOfDetail

java.util.List<RoverLevelOfDetail> listLevelsOfDetail()

Lists all levels of detail in the map.

Returns:

immutable list of all levels of detail in the map.

levelOfDetailFor

RoverLevelOfDetail levelOfDetailFor(int lodId)

Returns the level of detail for the given ID.

Parameters:

lodId - ID for level of detail desired

Returns:

LOD requested, or null if none corresponds to ID

listFindIndices

java.util.List<RoverStringIndex> listFindIndices()

Returns the available find indices for this map.

Returns:

immutable list of RoverFindIndexen.

nameFindIndices

Naming<RoverStringIndex> nameFindIndices()

Returns the available find indices for this map as a naming.

Returns:

Naming of RoverFindIndexen.

listStreamsFor

java.util.List<RoverBytes> listStreamsFor(int lodId,
                                          XyBounds bounds)

Returns the graphic streams required to render the given area.