MapDataItem

java.lang.Object
- com.partnersoft.maps.model.MapDataItem

All Implemented Interfaces:

Coggable
```
public class MapDataItem
extends java.lang.Object
implements Coggable
```
The data associated with a map entity.

Author:

Paul Reavis Copyright 2003 Partner Software, Inc.

Field Summary

Fields
Modifier and Type Field and Description

Naming data

int dataID

java.util.ArrayList hiliteEntities

int[] pieces

RoverSet roverSet

java.lang.Object sourceObject

Fields
Modifier and Type	Field and Description
`Naming`	`data`
`int`	`dataID`
`java.util.ArrayList`	`hiliteEntities`
`int[]`	`pieces`
`RoverSet`	`roverSet`
`java.lang.Object`	`sourceObject`

Constructor Summary

Constructors
Constructor and Description
`MapDataItem()`
`MapDataItem(Cog state)`
`MapDataItem(RoverSet roverSet, Naming data, int dataID)`
`MapDataItem(RoverSet roverSet, Naming data, int dataID, ByteBuffer hilite)`
`MapDataItem(RoverSet roverSet, Naming data, int dataID, java.lang.Object sourceObject)`

Method Summary

Methods
Modifier and Type	Method and Description
`MapConnectivityNode`	`connectivityNodeFor(java.lang.String networkName)`
`boolean`	`equals(java.lang.Object nother)`
`Naming`	`getData()`
`int`	`getDataID()`
`RoverSet`	`getDataSet()` For backwards compatibility only.
`java.lang.String`	`getDataType()`
`java.util.ArrayList`	`getHiliteEntities()`
`double`	`getLineLength()` Tries to determine the length of the first line found in the associated graphics.
`Point`	`getLocation()`
`Point`	`getLocation(double scale)`
`Point`	`getLocationNearest(double x, double y, double scale)`
`MapSet`	`getMapSet()`
`XyPoint`	`getParentPoint()` This is currently kind of a kludge.
`int[]`	`getPieces()` Merged find items are composed of multiple "pieces", each of which is an independent map data item in its own right.
`XyPoint`	`getPoint()`
`java.lang.String`	`getQuickDescription()`
`RoverBytes`	`getRoverBytes()` Returns the binary rover data used to highlight this item.
`RoverSet`	`getRoverSet()`
`java.util.List<MapDataGraphic>`	`getRoverShapes()` Deprecated.
`java.lang.Object`	`getSourceObject()`
`boolean`	`isArea()` Returns true if the first associated graphics is an Area geometry.
`boolean`	`isLine()` Returns true if the first associated graphics is a Line geometry.
`boolean`	`isPoint()` Returns true if the first associated graphics is a Point geometry.
`boolean`	`isText()` Returns true if the first associated graphics is a Text geometry.
`java.util.List<MapDataGraphic>`	`listMapDataGraphics()` Lists all MapDataGraphics associated with this item.
`java.util.List<RoverShape>`	`listShapes()` Lists all RoverShapes associated with this item.
`XyPoint`	`pointNearest(double x, double y, double scale, java.lang.String legend)` Legend-aware point nearest method.
`void`	`setData(Naming argData)`
`void`	`setDataID(int argId)`
`void`	`setHiliteEntities(java.util.ArrayList argHiliteEntities)`
`void`	`setRoverSet(RoverSet argRoverSet)`
`void`	`setSourceObject(java.lang.Object newSource)`
`Cog`	`toCog()` Returns the complete internal state of this object in the form of a `Cog`.
`XyPolyline`	`toPolyline()` Attempts to turn the graphics for this data item into a polyline.
`java.lang.String`	`toString()`
`TracingNodeContext`	`tracingNodeContextFor(java.lang.String networkName)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - roverSet
```
public RoverSet roverSet
```
  - data
```
public Naming data
```
  - dataID
```
public int dataID
```
  - hiliteEntities
```
public java.util.ArrayList hiliteEntities
```
  - sourceObject
```
public java.lang.Object sourceObject
```
  - pieces
```
public int[] pieces
```
- Constructor Detail
  - MapDataItem
```
public MapDataItem()
```
  - MapDataItem
```
public MapDataItem(Cog state)
```
  - MapDataItem
```
public MapDataItem(RoverSet roverSet,
           Naming data,
           int dataID)
```
  - MapDataItem
```
public MapDataItem(RoverSet roverSet,
           Naming data,
           int dataID,
           java.lang.Object sourceObject)
```
  - MapDataItem
```
public MapDataItem(RoverSet roverSet,
           Naming data,
           int dataID,
           ByteBuffer hilite)
```
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getQuickDescription
```
public java.lang.String getQuickDescription()
```
  - equals
```
public boolean equals(java.lang.Object nother)
```
    Overrides:
    
    equals in class java.lang.Object
  - getDataSet
```
public RoverSet getDataSet()
```
    For backwards compatibility only. Use getRoverSet() instead.
  - getRoverSet
```
public RoverSet getRoverSet()
```
  - setRoverSet
```
public void setRoverSet(RoverSet argRoverSet)
```
  - getMapSet
```
public MapSet getMapSet()
```
  - getData
```
public Naming getData()
```
  - setData
```
public void setData(Naming argData)
```
  - getDataID
```
public int getDataID()
```
  - setDataID
```
public void setDataID(int argId)
```
  - getPieces
```
public int[] getPieces()
```
    Merged find items are composed of multiple "pieces", each of which is an independent map data item in its own right. To examine each piece individually, use this method. It returns an array of dataIDs, one for each piece.
  - getDataType
```
public java.lang.String getDataType()
```
  - getHiliteEntities
```
public java.util.ArrayList getHiliteEntities()
```
  - setHiliteEntities
```
public void setHiliteEntities(java.util.ArrayList argHiliteEntities)
```
  - getSourceObject
```
public java.lang.Object getSourceObject()
```
  - setSourceObject
```
public void setSourceObject(java.lang.Object newSource)
```
  - getLocation
```
public Point getLocation()
```
  - getLocation
```
public Point getLocation(double scale)
```
  - pointNearest
```
public XyPoint pointNearest(double x,
                   double y,
                   double scale,
                   java.lang.String legend)
```
    Legend-aware point nearest method.
  - getLocationNearest
```
public Point getLocationNearest(double x,
                       double y,
                       double scale)
```
  - isPoint
```
public boolean isPoint()
```
    Returns true if the first associated graphics is a Point geometry.
  - isLine
```
public boolean isLine()
```
    Returns true if the first associated graphics is a Line geometry.
  - isText
```
public boolean isText()
```
    Returns true if the first associated graphics is a Text geometry.
  - isArea
```
public boolean isArea()
```
    Returns true if the first associated graphics is an Area geometry.
  - getRoverBytes
```
public RoverBytes getRoverBytes()
```
    Returns the binary rover data used to highlight this item.
    
    Returns:
  - getRoverShapes
```
public java.util.List<MapDataGraphic> getRoverShapes()
```
    Deprecated.
    
    Returns the object version of the highlight shapes as MapDataPoint, MapDataPolyline, MapDataText, etc. This is misleadingly named - it does not return RoverShape objects. See listShapes() for that.
  - listShapes
```
public java.util.List<RoverShape> listShapes()
```
    Lists all RoverShapes associated with this item. These are the new format, and may not work for older Rover format. Regardless, you will get a list, but it may be empty. See also listMapDataGraphics().
    
    Returns:
  - listMapDataGraphics
```
public java.util.List<MapDataGraphic> listMapDataGraphics()
```
    Lists all MapDataGraphics associated with this item. These are the old format, and may not work for newer Rover formats. Regardless, you will get a list, but it may be empty. See also listShapes().
    
    Returns:
  - toPolyline
```
public XyPolyline toPolyline()
```
    Attempts to turn the graphics for this data item into a polyline. Returns null if it cannot.
  - getLineLength
```
public double getLineLength()
```
    Tries to determine the length of the first line found in the associated graphics. Returns zero if there is no line in the associated graphics.
  - getPoint
```
public XyPoint getPoint()
```
  - getParentPoint
```
public XyPoint getParentPoint()
```
    This is currently kind of a kludge. Since the concept of a "parent" or "previous" point (e.g. for staking) is mapset- and model- dependent, there's not a good way to determine it from pure rover geometry. So, instead, just supply a partnerParentPoint data field in (x, y) format and it will use that if it can. Returns null otherwise.
  - connectivityNodeFor
```
public MapConnectivityNode connectivityNodeFor(java.lang.String networkName)
```
  - tracingNodeContextFor
```
public TracingNodeContext tracingNodeContextFor(java.lang.String networkName)
```
  - toCog
```
public Cog toCog()
```
    Description copied from interface: Coggable
    
    Returns the complete internal state of this object in the form of a Cog.
    
    Specified by:
    
    toCog in interface Coggable
    
    Returns:
    Cog representing the internal state of this object

Class MapDataItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

roverSet

data

dataID

hiliteEntities

sourceObject

pieces

Constructor Detail

MapDataItem

MapDataItem

MapDataItem

MapDataItem

MapDataItem

Method Detail

toString

getQuickDescription

equals

getDataSet

getRoverSet

setRoverSet

getMapSet

getData

setData

getDataID

setDataID

getPieces

getDataType

getHiliteEntities

setHiliteEntities

getSourceObject

setSourceObject

getLocation

getLocation

pointNearest

getLocationNearest

isPoint

isLine

isText

isArea

getRoverBytes

getRoverShapes

listShapes

listMapDataGraphics

toPolyline

getLineLength

getPoint

getParentPoint

connectivityNodeFor

tracingNodeContextFor

toCog