src.gov.nasa.worldwind.data.BasicRasterServer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation
Show all versions of worldwindx Show documentation
World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.
/*
* Copyright (C) 2012 United States Government as represented by the Administrator of the
* National Aeronautics and Space Administration.
* All Rights Reserved.
*/
package gov.nasa.worldwind.data;
import gov.nasa.worldwind.*;
import gov.nasa.worldwind.avlist.*;
import gov.nasa.worldwind.cache.*;
import gov.nasa.worldwind.exception.WWRuntimeException;
import gov.nasa.worldwind.formats.dds.DDSCompressor;
import gov.nasa.worldwind.geom.Sector;
import gov.nasa.worldwind.util.*;
import org.w3c.dom.*;
import javax.xml.xpath.*;
import java.awt.*;
import java.io.File;
import java.nio.ByteBuffer;
/**
* @author Lado Garakanidze
* @version $Id: BasicRasterServer.java 1171 2013-02-11 21:45:02Z dcollins $
*/
/**
* BasicRasterServer maintains a list of data sources and their properties in the BasicRasterServerCache and is used to
* compose (mosaic) a data raster of the given region of interest from data sources.
*/
public class BasicRasterServer extends WWObjectImpl implements RasterServer
{
protected final String XPATH_RASTER_SERVER = "/RasterServer";
protected final String XPATH_RASTER_SERVER_PROPERTY = XPATH_RASTER_SERVER + "/Property";
protected final String XPATH_RASTER_SERVER_SOURCE = XPATH_RASTER_SERVER + "/Sources/Source";
protected final String XPATH_RASTER_SERVER_SOURCE_SECTOR = XPATH_RASTER_SERVER_SOURCE + "/Sector";
protected java.util.List dataRasterList = new java.util.ArrayList();
protected DataRasterReaderFactory readerFactory;
protected static final MemoryCache cache = new BasicRasterServerCache();
/**
* BasicRasterServer constructor reads a list of data raster sources from *.RasterServer.xml (the file that
* accompanies layer description XML file), reads sector of each source and maintains a list of data sources, their
* properties,
*
* @param o the RasterServer.xml source to read. May by a {@link java.io.File}, a file path, a URL or an
* {@link org.w3c.dom.Element}
* @param params optional metadata associated with the data source that might be useful to the BasicRasterServer.
*/
public BasicRasterServer(Object o, AVList params)
{
super();
if (null != params)
{
this.setValues(params);
}
try
{
this.readerFactory = (DataRasterReaderFactory) WorldWind.createConfigurationComponent(
AVKey.DATA_RASTER_READER_FACTORY_CLASS_NAME);
}
catch (Exception e)
{
this.readerFactory = new BasicDataRasterReaderFactory();
}
this.init(o);
}
/** Returns an instance of the MemoryCache that contains DataRasters and their properties
*
* @return an instance of the MemoryCache that contains DataRasters and their properties
*/
public MemoryCache getCache()
{
return cache;
}
/**
* Returns TRUE, if the DataRaster list is not empty
*
* @return true, if the DataRaster list is not empty
*/
public boolean hasDataRasters()
{
return (this.dataRasterList.size() > 0);
}
protected void init(Object o)
{
if (null == o)
{
String message = Logging.getMessage("nullValue.ObjectIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
Element rootElement = null;
if (o instanceof Element)
{
rootElement = (Element) o;
}
else if (o instanceof Document)
{
rootElement = ((Document) o).getDocumentElement();
}
else
{
Document doc = WWXML.openDocument(o);
if (null != doc)
{
rootElement = doc.getDocumentElement();
}
}
if (null == rootElement)
{
String message = Logging.getMessage("generic.UnexpectedObjectType", o.getClass().getName());
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
String rootElementName = rootElement.getNodeName();
if (!"RasterServer".equals(rootElementName))
{
String message = Logging.getMessage("generic.InvalidDataSource", rootElementName);
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
XPath xpath = WWXML.makeXPath();
this.extractProperties(rootElement, xpath);
if( this.readRasterSources(rootElement, xpath) )
{
// success, all raster sources are available
String message = Logging.getMessage("generic.DataSetAvailable", this.getDataSetName() );
Logging.logger().finest(message);
}
else
{
// some (or all) required source rasters are not available (either missing or unreadable)
// and therefore the dataset may not generate high resolution on-the-fly
String message = Logging.getMessage("generic.DataSetLimitedAvailability", this.getDataSetName() );
Logging.logger().severe(message);
}
}
protected String getDataSetName()
{
return AVListImpl.getStringValue( this, AVKey.DATASET_NAME, "" );
}
/**
* Returns DataSet's pixel format (AVKey.IMAGE or AVKey.ELEVATION), or empty string if not set
*
* @return DataSet's pixel format (AVKey.IMAGE or AVKey.ELEVATION), or empty string if not set
*/
protected String getDataSetPixelFormat()
{
return AVListImpl.getStringValue( this, AVKey.PIXEL_FORMAT, "" );
}
protected void setDataSetPixelFormat(String pixelFormat)
{
this.setValue(AVKey.PIXEL_FORMAT, pixelFormat);
}
/**
* Extracts all