dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/state/layer/LayerOutputState.java comparison

comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/layer/LayerOutputState.java @ 813:79c1db3ca7cc

Added some more javadocs. gnv-artifacts/trunk@897 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Fri, 09 Apr 2010 13:09:25 +0000
parents	feae2f9d6c6f
children	ac1b9f00603f

comparison

equal deleted inserted replaced

-:41a7c49b5cb4
+:79c1db3ca7cc
 */
 public LayerOutputState() {
 super();
 }
-/**
-* @see de.intevation.gnv.state.OutputState#out(org.w3c.dom.Document,
-*      java.util.Collection, java.io.OutputStream,
-*      java.lang.String, de.intevation.artifacts.CallContext)
-*/
 public void out(Document format, Collection<InputData> inputData,
 OutputStream outputStream, String uuid,
 CallContext callContext) throws StateException {
 log.debug("LayerOutputState.out");
 }
 }
 /**
-* @param outputStream
+* Writes an exception to an output stream.
-*/
+*
+* @param outputStream The output stream used to write the exception to.
+*/
+@SuppressWarnings("static-access")
 private void writeExceptionReport2Stream(OutputStream outputStream) {
 Document document = XMLUtils.newDocument();
-new ArtifactXMLUtilities().
+ArtifactXMLUtilities.
 createExceptionReport("No Data to Export", document);
 XMLUtils.toStream(document,outputStream);
 }
 /**
-* Fetches the Data from the Databasebackend
+* Fetches the Data from the Databasebackend.
-* @return
+*
+* @return the resulting data.
 */
 protected Collection<Result> fetchData(){
 log.debug("LayerOutputState.fetchData");
 // TODO PUT ALL in CACHE
 Collection<Result> result = this.getData(this.queryID);
 }
 }
 return data;
 }
+/**
+* This method determines the geometry type on basis of a table name.
+*
+* @param tableName Name of the table in the database.
+* @param queryExecutor The QueryExecutor.
+* @return the geometry type as string (e.g. MultiPolygon, Polygon, etc).
+*/
 private String getGeometryType(String tableName,
 QueryExecutor queryExecutor){
 String returnValue = null;
 String[] tables = tableName.toUpperCase().split(",");
 String[] filter = tables[0].split("\\.");
 log.error(e,e);
 }
 return returnValue;
 }
+/**
+* Fetch the columns of a specific table.
+*
+* @param tableName The name of the table.
+* @return the columns as string.
+*/
 private String fetchColumns(String tableName){
 String returnValue = null;
 try {
 String[] tables = tableName.toUpperCase().split(",");
 String[] filter = tables[0].split("\\.");
 } catch (QueryException e) {
 log.error(e,e);
 }
 return returnValue;
 }
 @Override
 public void setup(Node configuration) {
 log.debug("LayerOutputState.setup");
 super.setup(configuration);
 this.dataQueryID = Config.getStringXPath(configuration,
 this.columnQueryID =   "layer_colums"; //Config.getStringXPath(configuration,
 // "queryID-columns");
 this.geometryTypeQueryID = "geometry_type";
 }
+/**
+* Write the resulting data to shapefiles.
+*
+* @param uuid The UUID of the current artifact.
+* @param data The finalized data used for shapefile creation.
+* @param callContext The CallContext object.
+* @param geometryType The geometry type.
+* @return the shapefile path.
+*/
 protected String writeToShapeFile(
 String             uuid,
 Collection<Result> data,
 CallContext        callContext,
 String geometryType
 FileUtils.deleteRecursive(shapeDir);
 }
 }
 }
+/**
+* Create a zip archive with the shapefiles of the given shapefiles path and
+* write it to <code>output</code>.
+*
+* @param uuid The UUID of the current artifact.
+* @param callContext The CallContext object.
+* @param output The output stream.
+* @param data The data to be written to shapefile.
+* @param geometryType The geometry type.
+* @throws StateException if an error occured while zipfile creation.
+*/
 protected void writeZip(
 String       uuid,
 CallContext  callContext,
 OutputStream output,
 Collection<Result> data,
 catch (IOException ioe) {
 log.error(ioe.getLocalizedMessage(), ioe);
 }
 }
+/**
+* Returns the shapefile path.
+*
+* @return the shapefile path.
+*/
 public String getShapeFilePath() {
 synchronized (shapeFileLock) {
 return shapeFilePath;
 }
 }
 private static File shapefileDirectory(CallContext callContext) {
 // TODO: Refactoring nessessary it should be used only one Shapefilepath
 //       for alle Modes. Code was taken from HorizontalCrossSectionMeshOutputState
 GNVArtifactContext context =
 (GNVArtifactContext)callContext.globalContext();
 return dir != null
 ? dir
 : GNVArtifactContext.DEFAULT_HORIZONTAL_CROSS_SECTION_PROFILE_SHAPEFILE_PATH;
 }
-/**
-* @see de.intevation.gnv.state.StateBase#endOfLife(java.lang.Object)
-*/
 @Override
 public void endOfLife(Object globalContext) {
 super.endOfLife(globalContext);
 // do it in background
 new Thread() {
+@Override
 public void run() {
 // TODO: Do the un-publishing WMS stuff.
 String path = resetShapeFilePath();
 if (path == null) {
 log.error("failed to remove directory '" + path + "'");
 } // run
 }.start();
 }
 public String resetShapeFilePath() {
 synchronized (shapeFileLock) {
 String path = shapeFilePath;
 shapeFilePath = null;
 templateID = null;
 return path;
 }
 }
+/**
+* Write data to shapefiles and feed a map service with information about
+* these shapefiles. The map service can be queried for displaying
+* corresponding layers as WMS.
+*
+* @param uuid The UUID of the current artifact.
+* @param callContext The CallContext object.
+* @param data A collection with some input data.
+* @param geometryType The geometry type.
+* @return a document with some meta information (shapefile path, geometry
+* type, time to live of the current artifact, etc).
+* @throws StateException if an error occured while shapefile writing.
+*/
 protected Document getWMS(String uuid,
 CallContext callContext,
 Collection<Result> data,
 String geometryType)
 throws StateException
 }
 return document;
 }
+/**
+* Turns the geometry type into a form used for the templating mechanism
+* while mapfile generation.
+*
+* @param geometryType The original geometry type.
+* @return a valid geometry type fpr the template mechanism.
+*/
 private String determineGeometryType(String geometryType){
 String returnValue = geometryType.toLowerCase();
 if (returnValue.equalsIgnoreCase("linestring")){
 returnValue = "Polygon";
 }
 return returnValue;
 }
+/**
+* Determine the default template name if no special template is existing
+* for this layer.
+*
+* @param geometryType The geometry type.
+* @return a default geometry fitting to the original geometry type.
+*/
 private String determineDefaultTemplateName(String geometryType){
 String returnValue = geometryType.toLowerCase();
 if (returnValue.equalsIgnoreCase("multilinestring")){
 returnValue = "point";
 }
 return returnValue;
 }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/layer/LayerOutputState.java @ 813:79c1db3ca7cc