dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/utils/MapfileGenerator.java comparison

comparison gnv-artifacts/src/main/java/de/intevation/gnv/utils/MapfileGenerator.java @ 806:2cea76f1112e

Added Javadoc in utils package. gnv-artifacts/trunk@888 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Thu, 08 Apr 2010 13:10:39 +0000
parents	6cff63d0c434
children	a645bd23c1c8

comparison

equal deleted inserted replaced

-:bb7afd783321
+:2cea76f1112e
 import org.w3c.dom.Document;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 /**
+* This class iterates over a bunch of directories, searches for meta
+* information coresponding to shapefiles and creates a mapfile which is used by
+* a <i>MapServer</i>.
+*
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
 public class MapfileGenerator
 extends Thread
 {
+/**
+* The configured template path.
+*/
 public static final String TEMPLATE_PATH =
 "/artifact-database/gnv/map-generator/templates/path/text()";
+/**
+* The configured template mapfile.
+*/
 public static final String TEMPLATE_MAPFILE =
 "/artifact-database/gnv/map-generator/templates/maptemplate/text()";
+/**
+* The configured mapfile path.
+*/
 public static final String MAPFILE_PATH =
 "/artifact-database/gnv/map-generator/mapfile/@path";
+/**
+* The configured shapefile base directory where the subdirectories for each
+* artifact are stored.
+*/
 public static final String SHAPEFILE_BASE_DIR =
 "/artifact-database/gnv/shapefile-directory/@path";
+/**
+* The configured velocity logfile.
+*/
 public static final String VELOCITY_LOGFILE =
 "/artifact-database/velocity/logfile/@path";
+/**
+* The name of the file storing meta information coresponding to shapefiles.
+*/
 public static final String META_FILE_NAME = "meta.xml";
+/**
+* The XPath to layer nodes in the meta information xml file.
+*/
 public static final String XPATH_LAYER        = "/art:meta/art:layer";
 public static final String XPATH_LAYER_NAME   = "art:name";
 public static final String XPATH_LAYER_TITLE  = "art:title";
 public static final String XPATH_LAYER_TYPE   = "art:type";
 public static final String XPATH_LAYER_DATA   = "art:data";
 public static final String XPATH_LAYER_STATUS = "art:status";
 private MapfileGenerator() {
 lock = new boolean[1];
 }
+/**
+* A main method which can be used to create a mapfile without a running
+* artifact server.<br>
+* <b>NOTE:</b> This method is not implemented yet!
+*
+* @param args Arguments.
+*/
 public static void main(String[] args) {
 // TODO IMPLEMENT ME
 }
+/**
+* Returns the instance of this generator.
+*
+* @return the instance.
+*/
 public static synchronized MapfileGenerator getInstance() {
 if (instance == null) {
 instance = new MapfileGenerator();
 instance.setDaemon(true);
 instance.start();
 return instance;
 }
+/**
+* Triggers the mapfile generation process.
+*/
 public void update() {
 synchronized (lock) {
 logger.debug("update");
 lock[0] = true;
 lock.notify();
 }
 }
+/**
+* Thread to generate a mapfile.
+*/
+@Override
 public void run() {
 logger.debug("Start MapfileGenerator thread...");
 try {
 for (;;) {
 synchronized (lock) {
 finally {
 logger.debug("THREAD END");
 }
 }
+/**
+* Method to check the existance of a template file.
+*
+* @param templateID The name of a template.
+* @return true, of the template exists - otherwise false.
+*/
 public boolean templateExists(String templateID){
 Template template = getTemplateByName(templateID);
 return template != null;
 }
+/**
+* Method which starts searching for meta information file and mapfile
+* generation.
+*/
 protected void generate() {
 File basedir       = new File(getShapefileBaseDir());
 List layers        = new ArrayList();
 searchMetaInformation(basedir, layers);
 writeMapfile(layers);
 }
+/**
+* Returns the VelocityEngine used for the template mechanism.
+*
+* @return the velocity engine.
+*/
 protected VelocityEngine getVelocityEngine() {
 if (velocityEngine == null) {
 velocityEngine = new VelocityEngine();
 try {
 setupVelocity(velocityEngine);
 }
 return velocityEngine;
 }
+/**
+* Initialize velocity.
+*
+* @param engine Velocity engine.
+* @throws Exception if an error occured while initializing velocity.
+*/
 protected void setupVelocity(VelocityEngine engine)
 throws Exception
 {
 engine.setProperty(
 "input.encoding",
 engine.init();
 }
+/**
+* Returns the path specifying the logfile for velocity.
+*
+* @return Velocity logfile path.
+*/
 protected String getVelocityLogfile() {
 if (velocityLogfile == null)
 velocityLogfile = Config.getStringXPath(VELOCITY_LOGFILE);
 return velocityLogfile;
 }
+/**
+* Returns the base directory storing the templates.
+*
+* @return the template base directory.
+*/
 protected String getTemplateBaseDir() {
 if (templatePath == null) {
 templatePath = Config.getStringXPath(TEMPLATE_PATH);
 templatePath = Config.replaceConfigDir(templatePath);
 }
 return templatePath;
 }
+/**
+* Returns a template specified by <i>model</i>.
+*
+* @param model The name of the template.
+* @return a template.
+*/
 protected Template getTemplateByName(String model) {
 if (model.indexOf(".vm") < 0) {
 model = model.concat(".vm");
 }
 return null;
 }
+/**
+* Returns the mapfile  template.
+*
+* @return the mapfile template.
+* @throws Exception if an error occured while reading the configuration.
+*/
 protected Template getMapfileTemplate()
 throws Exception
 {
 String mapfileName = Config.getStringXPath(TEMPLATE_MAPFILE);
 return getTemplateByName(mapfileName);
 }
+/**
+* Returns the base directory storing the shapefiles.
+*
+* @return the shapefile base directory.
+*/
 protected String getShapefileBaseDir() {
 if (shapefileDirectory == null) {
 shapefileDirectory = Config.getStringXPath(SHAPEFILE_BASE_DIR);
 shapefileDirectory = Config.replaceConfigDir(shapefileDirectory);
 }
 return shapefileDirectory;
 }
+/**
+* Returns the mapfile.
+*
+* @return the mapfile.
+*/
 protected File getMapfile() {
 if (mapfile == null) {
 String tmp = Config.getStringXPath(MAPFILE_PATH);
 tmp        = Config.replaceConfigDir(tmp);
 mapfile    = new File(tmp);
 return mapfile;
 }
+/**
+* Search for meta information file in <i>file</i> and store the layer
+* information in <i>store</i> if a meta file was found.
+*
+* @param file The root directory to be searched for meta files.
+* @param store A list storing <code>LayerInfo</code> objects.
+*/
 protected void searchMetaInformation(File file, List store) {
 if (file.isDirectory()) {
 File[] files = file.listFiles();
 if (files != null && files.length != 0) {
 }
 }
 }
+/**
+* Parses a meta information file and returns necessary information as
+* <code>LayerInfo</code> array.
+*
+* @param file Meta information file.
+* @return Array of LayerInfo objects.
+*/
 protected LayerInfo[] parseMeta(File file) {
 Document meta = XMLUtils.parseDocument(file);
 List layers   = new ArrayList();
 NodeList layerset = (NodeList) XMLUtils.xpath(
 return (LayerInfo[]) layers.toArray(new LayerInfo[layers.size()]);
 }
+/**
+* Parses a node storing layer information and returns them.
+*
+* @param layer Node storing information about a layer.
+* @return a LayerInfo object.
+*/
 protected LayerInfo parseLayer(Node layer) {
 LayerInfo info  = new LayerInfo();
 String name = parseLayerAttr(layer, XPATH_LAYER_NAME);
 if (name != null && !name.equals("")) {
 return info;
 }
+/**
+* Parses attributes in layer nodes.
+*
+* @param node A node containing layer information.
+* @param xpath XPath specifying an attribute.
+* @return Attribute as string.
+*/
 protected String parseLayerAttr(Node node, String xpath) {
 return (String) XMLUtils.xpath(
 node,
 xpath,
 XPathConstants.STRING,
 ArtifactNamespaceContext.INSTANCE);
 }
+/**
+* Creates a mapfile with the layer information stored in <i>layers</i>.
+*
+* @param layers Layer information.
+*/
 protected void writeMapfile(List layers) {
 String tmpMapName = "mapfile" + new Date().getTime();
 int layersize         = layers.size();
 StringBuilder sb      = new StringBuilder();

Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/utils/MapfileGenerator.java @ 806:2cea76f1112e