gov.nasa.worldwind

Interface Restorable

All Known Subinterfaces:

Airspace, AirspaceEditor, Annotation, ElevationModel, Layer, OrbitView, SurfaceShape, View, WWIcon

All Known Implementing Classes:

AbstractAirspace, AbstractAirspaceEditor, AbstractAnnotation, AbstractElevationModel, AbstractGeneralShape, AbstractGraticuleLayer, AbstractLayer, AbstractShape, AbstractShapeEditor, AbstractSurfaceShape, AnalysisPanel, AnnotationAttributes, AnnotationLayer, AntennaAxes, AntennaModel, AudioPlayerAnnotation, BasicElevationModel, BasicFlyView, BasicMercatorTiledImageLayer, BasicOrbitView, BasicTiledImageLayer, BasicView, BathymetryFilterElevationModel, BMNGOneImage, BMNGWMSLayer, Box, Box, BoxEditor, ButtonAnnotation, CachedRenderableLayer, Cake, Cake.Layer, CappedCylinder, CappedEllipticalCylinder, CloudCeiling, CloudCeilingPanel, ColladaMeshShape, CompassLayer, CompoundElevationModel, Cone, ConeEditor, CountryBoundariesLayer, CrosshairLayer, Curtain, Cylinder, CylinderEditor, DialogAnnotation, DialogAnnotation.BusyImage, DirectedPath, DirectedSurfacePolyline, EditorAnnotation, ElevationPlane, Ellipsoid, ExtrudedPolygon, ExtrudedPolygonEditor, GARSGraticuleLayer, GliderImageLayer, GlobeAnnotation, IconLayer, ImageAnnotation, KMLExtrudedPolygonImpl, KMLGroundOverlayPolygonImpl, KMLLineStringPlacemarkImpl, KMLPolygonImpl, KMLSurfacePolygonImpl, LandsatI3WMSLayer, LatLonGraticuleLayer, LayerManagerLayer, LocalElevationModel, LocalRasterServerElevationModel, LocalRasterServerLayer, MarkerLayer, MarkersOrder.AppFrame.TimedMarkerLayer, MeasureTool.ControlPoint, MeasureTool.ControlPointWithLeader, MeasureTool.CustomRenderableLayer, MercatorTiledImageLayer, MGRSGraticuleLayer, MSVirtualEarthLayer, NASAWFSPlaceNameLayer, OpenStreetMapShapefileLoader.TextAndShapesLayer, Orbit, OSMCycleMapLayer, OSMMapnikLayer, PartialCappedCylinder, Path, Pedestal, PickFrustum.PickFrustumLayer, PlaceNameLayer, PolyArc, Polygon, Polygon, PolygonEditor, ProgressAnnotation, Pyramid, PyramidEditor, RadarVolume, RenderableLayer, RigidShape, RigidShapeEditor, Route, RPFTiledImageLayer, SARAnnotation, ScalebarLayer, ScankortDenmarkImageLayer, ScreenAnnotation, ScreenRelativeAnnotation, SectorSelector.RegionShape, SegmentPlaneEditor, SkyColorLayer, SkyGradientLayer, SlideShowAnnotation, SphereAirspace, SphereAirspaceEditor, StarsLayer, StatusLayer, StatusLayer.StatusMGRSLayer, StatusLayer.StatusUTMLayer, SurfaceBox, SurfaceCircle, SurfaceEllipse, SurfaceImageLayer, SurfaceMultiPolygon, SurfacePolygon, SurfacePolygons, SurfacePolyline, SurfacePolylines, SurfaceQuad, SurfaceSector, SurfaceSquare, TerrainProfileLayer, TerrainProfilePanel, TiledImageLayer, ToolTipAnnotation, ToolTipAnnotation, TrackAirspace, USDANAIPWMSImageLayer, UserFacingIcon, USGSDigitalOrtho, USGSTopoHighRes, USGSTopoLowRes, USGSTopoMedRes, USGSUrbanAreaOrtho, UTMBaseGraticuleLayer, UTMGraticuleLayer, ViewControlsLayer, ViewVolumeViewer.SectorGeometryLayer, ViewVolumeViewer.ViewVolumeLayer, WCSElevationModel, Wedge, WedgeEditor, WMSBasicElevationModel, WMSTiledImageLayer, WorldMapLayer, WWOMeasureToolControlPoints.ControlPoint, ZeroElevationModel

public interface Restorable

Restorable is an interface for describing the current state of an object, and restoring an object's state. Object state descriptions will be formatted as an XML document string. This allows the state description to be located in a file, reside in a database, or be passed over a network.

The exact structure of the XML document is the responsibility of the implementation. However, to encourage data sharing between similar implementations, each implementation of Restorable should design restoreState to accept and ignore unknown structures in state documents. Otherwise, implementations should clearly document how they will behave when encountering an unknown structure.

See the WorldWideWeb Consortium's (W3C) documentation on Extensible Markup Language (XML) 1.1 for information on XML.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRestorableState() Returns an XML document string describing the object's state.
void	restoreState(java.lang.String stateInXml) Restores the object's state to what is described in the specified XML document string.

Method Detail

getRestorableState

java.lang.String getRestorableState()

Returns an XML document string describing the object's state. This state can be restored later by calling restoreState and passing the XML document.

Returns:

an XML document string describing the object's state.

restoreState

void restoreState(java.lang.String stateInXml)

Restores the object's state to what is described in the specified XML document string.

Parameters:

stateInXml - an XML document string describing an object's state.