# HG changeset patch # User Ingo Weinzierl # Date 1271055573 0 # Node ID 22c18083225e2ede3828f3320cdf12b93c53f69a # Parent 9d427dd2a96addedb16c851dc02f2fbffd9a8b73 Removed compiler warnings while JavaDoc generation. gnv-artifacts/trunk@900 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/ChangeLog --- a/gnv-artifacts/ChangeLog Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/ChangeLog Mon Apr 12 06:59:33 2010 +0000 @@ -1,3 +1,46 @@ +2010-04-12 Ingo Weinzierl + + * src/main/java/de/intevation/gnv/state/DefaultAutoResumeState.java, + src/main/java/de/intevation/gnv/state/DefaultInputValue.java, + src/main/java/de/intevation/gnv/state/SingleInputState.java, + src/main/java/de/intevation/gnv/state/StateFactory.java, + src/main/java/de/intevation/gnv/state/StateBase.java, + src/main/java/de/intevation/gnv/state/MeasurementState.java, + src/main/java/de/intevation/gnv/state/InputData.java, + src/main/java/de/intevation/gnv/state/MinMaxState.java, + src/main/java/de/intevation/gnv/state/DefaultExportMode.java, + src/main/java/de/intevation/gnv/state/OutputStateBase.java, + src/main/java/de/intevation/gnv/state/DefaultInputData.java, + src/main/java/de/intevation/gnv/state/CoordinateSelectionState.java, + src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java, + src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java, + src/main/java/de/intevation/gnv/artifacts/GNVProductArtifactFactory.java, + src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java, + src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java, + src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java, + src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java, + src/main/java/de/intevation/gnv/math/AreaInterpolation.java, + src/main/java/de/intevation/gnv/math/GridCell.java, + src/main/java/de/intevation/gnv/transition/Transition.java, + src/main/java/de/intevation/gnv/utils/ExclusiveExec.java, + src/main/java/de/intevation/gnv/chart/DefaultHistogram.java, + src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java, + src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java, + src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java, + src/main/java/de/intevation/gnv/exports/ShapeDataCollector.java, + src/main/java/de/intevation/gnv/exports/ChartExportHelper.java, + src/main/java/de/intevation/gnv/exports/DefaultExport.java, + src/main/java/de/intevation/gnv/exports/ODVExport.java, + src/main/java/de/intevation/gnv/jfreechart/LevelOrderIndices.java, + src/main/java/de/intevation/gnv/jfreechart/PolygonSeries.java, + src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java, + src/main/java/de/intevation/gnv/jfreechart/CompactXYItems.java, + src/main/java/de/intevation/gnv/jfreechart/PolygonRenderer.java: Removed + JavaDoc compiler warnings caused by broken references and fields without + content. + 2010-04-09 Ingo Weinzierl * src/main/java/de/intevation/gnv/statistics/StatisticSet.java, diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVArtifactBase.java Mon Apr 12 06:59:33 2010 +0000 @@ -56,7 +56,7 @@ /** * This is the major gnv artifact and handles the requests specified in - * {@link de.intevation.artifactdatabase.Artifact}. + * de.intevation.artifactdatabase.Artifact. * * @author Tim Englich * @author Ingo Weinzierl @@ -86,39 +86,18 @@ + XPATH_IDENTIFIER_REPLACE + "']"; - /** - * - */ public static final String XPATH_STATIC_NODE = "/art:result/art:ui/art:static"; - /** - * - */ public static final String XPATH_INPUT_DATA = "/art:action/art:data/art:input"; - /** - * - */ public static final String XPATH_INCLUDE_UI = "/art:action/art:include-ui"; - /** - * - */ public static final String XPATH_TARGET_NAME = "/art:action/art:target/@name"; - /** - * - */ public static final String XPATH_OUTPUT_NAME = "/art:action/art:out/@name"; - /** - * - */ public static final String XPATH_OUTPUT_PARAMS = "/art:action/art:out/art:params/art:input"; - /** - * - */ public static final String INITIAL_STATE = "product"; /** @@ -165,10 +144,6 @@ * This method handles request for changing the current state of an * artifact. It is possible to step forward, backward, or to the initial * state for choosing a fis. - * - * @param target - * @param context - * @return */ @Override public Document advance(Document target, CallContext context) { @@ -273,13 +248,6 @@ } - /** - * @param context - * @param result - * @param next - * @return - * @throws StateException - */ private boolean go2NextState(CallContext context, Document result, State next) throws StateException { // 2. Transfer Results @@ -301,14 +269,6 @@ } - /** - * - * @param document - * @param nodeName - * @param state - * @param msg - * @return - */ protected Document createReport( Document document, String nodeName, @@ -335,9 +295,6 @@ /** * Step back to the previous state specified by name. - * @param current - * @param name - * @return */ protected State getPreviousState(State current, String name) { if (current == null) { @@ -367,11 +324,7 @@ return false; } - /** - * - * @param context - * @return - */ + public Document initialize(CallContext context) { Document result = XMLUtils.newDocument(); try { @@ -429,22 +382,14 @@ return null; } - /** - * - * @param document - * @return - */ + protected String readStateName(Document document) { String returnValue = XMLUtils.xpathString( document, XPATH_TARGET_NAME, ArtifactNamespaceContext.INSTANCE); return returnValue; } - /** - * - * @param document - * @return - */ + protected Node getConfigurationFragment(Document document) { log.debug("GNVArtifactBase.getConfigurationFragment"); String xpathQuery = XPATH_ARTIFACT_CONFIGURATION.replaceAll( @@ -466,8 +411,6 @@ * @param target XML document which contains data. * @param context CallContext * @return XML document with success or error message. - * @see de.intevation.artifactdatabase.DefaultArtifact#feed(org.w3c.dom.Document, - * de.intevation.artifacts.CallContext) */ @Override public Document feed(Document target, CallContext context) { @@ -514,10 +457,7 @@ /** * Describe the current artifact. - * @param data - * @param context * @return The description of the current artifact. - * @see de.intevation.artifactdatabase.DefaultArtifact#describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext) */ @Override public Document describe(Document data, CallContext context) { @@ -535,11 +475,6 @@ /** * Initialse this artifact and insert some data if data * contains necessary information for this artifact. - * @param identifier - * @param context - * @param factory - * @param data - * @see de.intevation.artifactdatabase.DefaultArtifact#setup(java.lang.String, de.intevation.artifacts.ArtifactFactory, java.lang.Object, org.w3c.dom.Document) */ @Override public void setup(String identifier, ArtifactFactory factory, @@ -592,11 +527,6 @@ /** * Create the xml document returned in {@link #describe(org.w3c.dom.Document, * de.intevation.artifacts.CallContext)} - * - * @param context - * @param uuid - * @param incudeUI - * @return */ protected Document createDescibeOutput( CallContext context, @@ -628,7 +558,6 @@ * Determine the wish to append the user interface description to the * describe document. * - * @param document * @return True, if the user interface description should be appended, * otherwise false. */ @@ -643,12 +572,7 @@ return includeUI; } - /** - * - * @param creator - * @param document - * @return - */ + protected Element createRootNode( XMLUtils.ElementCreator creator, Document document @@ -660,11 +584,6 @@ /** * Append information about the current artifact (uuid, hash). - * - * @param creator - * @param parent - * @param document - * @param documentType */ protected void createHeader( XMLUtils.ElementCreator creator, @@ -687,12 +606,6 @@ /** * Create the fis select box. - * - * @param artCreator - * @param creator - * @param document - * @param context - * @return */ protected Element createSelectBox( XMLUtils.ElementCreator artCreator, @@ -743,10 +656,6 @@ /** * Insert all reachable states into the describe document returned by * {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)} - * - * @param creator - * @param parent - * @param document */ protected void createReachableStates( XMLUtils.ElementCreator creator, @@ -784,10 +693,6 @@ * Insert states which have been visited by this artifact into the xml * document returned by {@link #describe(org.w3c.dom.Document, * de.intevation.artifacts.CallContext)} - * - * @param creator - * @param parent - * @param state */ protected void appendOldReachableStates( XMLUtils.ElementCreator creator, @@ -811,9 +716,6 @@ /** * Insert the current state into the xml document returned by * {@link #describe(org.w3c.dom.Document, de.intevation.artifacts.CallContext)} - * @param creator - * @param parent - * @param document */ protected void createCurrentState( XMLUtils.ElementCreator creator, @@ -826,12 +728,7 @@ parent.appendChild(stateNode); } - /** - * - * @param creator - * @param parent - * @param document - */ + protected void createModel( XMLUtils.ElementCreator creator, Element parent, @@ -1022,8 +919,6 @@ * @param context CallContext * @throws IOException If an error occured while writing the result to the * output stream. - * @see de.intevation.artifactdatabase.DefaultArtifact#out(org.w3c.dom.Document, - * java.io.OutputStream, de.intevation.artifacts.CallContext) */ @Override public void out(Document format, OutputStream outputStream, @@ -1043,11 +938,7 @@ } } - /** - * - * @param document - * @return - */ + protected static String readOutputType(Document document) { String value = XMLUtils.xpathString( document, XPATH_OUTPUT_NAME, ArtifactNamespaceContext.INSTANCE); @@ -1065,7 +956,6 @@ /** * Call endOfLife of parent class and the current state. - * @param globalContext */ @Override public void endOfLife(Object globalContext) { @@ -1079,8 +969,6 @@ /** * Retrieves a map with given InputData which have been inserted into the * current artifact before the parameterization began. - * @return - * @see de.intevation.gnv.artifacts.PreSettingArtifact#getPreSettings() */ public Map getPreSettings() { return this.preSettings; @@ -1088,8 +976,6 @@ /** * Set InputData which are used in later states. - * @param preSettings - * @see de.intevation.gnv.artifacts.PreSettingArtifact#setPreSettings(java.util.Map) */ public void setPreSettings(Map preSettings) { this.preSettings = preSettings; diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVProductArtifactFactory.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVProductArtifactFactory.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/GNVProductArtifactFactory.java Mon Apr 12 06:59:33 2010 +0000 @@ -35,35 +35,17 @@ */ public class GNVProductArtifactFactory extends DefaultArtifactFactory { - /** - * - */ public static final String XPATH_REPLACE_NAME = "IDENTIFIER"; - /** - * - */ public static final String XPATH_PRODUCT_ARTIFACT = "artifact-database/artifacts/artifact[@name='"+XPATH_REPLACE_NAME+"']"; - /** - * - */ public static final String XPATH_PRODUCT = "products/product"; - /** - * - */ public static final String XPATH_PRODUCT_NAME = "@name"; - /** - * - */ public static final String XPATH_PRODUCT_FACTORY = "artifact-factory"; - /** - * - */ public static final String XPATH_PRODUCT_PARAMETER = "parameters/parameter"; private Logger logger = Logger.getLogger(GNVProductArtifactFactory.class); @@ -105,11 +87,7 @@ return artifact; } - /** - * - * @param document - * @param factoryNode - */ + @Override public void setup(Document document, Node factoryNode) { super.setup(document, factoryNode); @@ -137,21 +115,11 @@ } - /** - * - * @param name - * @return - */ public ArtifactFactory getArtifactFactoryByName(String name) { return (ArtifactFactory) productFactories.get(name); } - /** - * - * @param document - * @param products - */ protected void parseProductFactories(Document document, NodeList products) { int items = products.getLength(); @@ -195,7 +163,6 @@ /** * Initialize all products supported by the current fis. - * @param productNode */ protected void initializeProducts(Node productNode) { String productName = (String) XMLUtils.xpath( diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/context/GNVArtifactContext.java Mon Apr 12 06:59:33 2010 +0000 @@ -16,8 +16,8 @@ * This class defines some final fields used to store some meta information * required during the work with an artifact into a context object which is * available in each request specified in - * {@link de.intevation.gnv.artifacts.Artifacts} and further methods called by - * those. + * de.intevation.gnv.artifacts.Artifacts and further methods called + * by those. * * @author Tim Englich * @author Sascha L. Teichmann @@ -30,150 +30,79 @@ */ private static Logger log = Logger.getLogger(GNVArtifactContext.class); - /** - * - */ public static final String CHART_TEMPLATE_KEY = "gnv.chart.template"; - /** - * - */ public static final String HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES_KEY = "gnv.horizontal.cross.section.profile.samples"; - /** - * - */ public static final String HORIZONTAL_CROSS_SECTION_SAMPLES_KEY = "gnv.horizontal.cross.section.samples"; - /** - * - */ public static final String HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS_KEY = "gnv.horizontal.cross.section.extrapolation.rounds"; - /** - * - */ public static final String HORIZONTAL_CROSS_SECTION_RESULT_SHAPEFILE_PATH_KEY = "gnv.horizontal.cross.section.result.shapefile"; - /** - * - */ public static final File DEFAULT_HORIZONTAL_CROSS_SECTION_PROFILE_SHAPEFILE_PATH = new File(System.getProperty("java.io.tmpdir")); - /** - * - */ public static final Integer DEFAULT_HORIZONTAL_CROSS_SECTION_PROFILE_SAMPLES = Integer.valueOf(250); - /** - * - */ public static final Integer DEFAULT_HORIZONTAL_CROSS_SECTION_SAMPLES = Integer.valueOf(1024); - /** - * - */ public static final Integer DEFAULT_HORIZONTAL_CROSS_SECTION_EXTRAPOLATION_ROUNDS = Integer.valueOf(0); - /** - * - */ public static final String HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY = "gnv.horizontal.cross.section.ground.interpolation"; - /** - * - */ public static final String DEFAULT_HORIZONTAL_CROSS_SECTION_GROUND_INTERPOLATION = "bilinear"; - /** - * - */ public static final String PALETTES_KEY = "gnv.color.palettes"; - /** - * - */ public static final String VERTICAL_CROSS_SECTION_SAMPLES_KEY = "gnv.vertical.cross.section.samples"; - /** - * - */ public static final Dimension DEFAULT_VERTICAL_CROSS_SECTION_SAMPLES = new Dimension(1024, 768); - /** - * - */ public static final String VERTICAL_CROSS_SECTION_FILTER_FACTORIES_KEY = "gnv.vertical.cross.section.filter.factories"; - /** - * - */ public static final String VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION_KEY = "gnv.vertical.cross.section.ground.interpolation"; - /** - * - */ public static final String DEFAULT_VERTICAL_CROSS_SECTION_GROUND_INTERPOLATION = "bilinear"; - /** - * - */ public static final String VERTICAL_CROSS_SECTION_GROUND_FILL_KEY = "gnv.vertical.cross.section.ground.fill"; - /** - * - */ public static final String MAPSERVER_SERVER_PATH_KEY = "mapserver.server.path"; - /** - * - */ public static final String MAPSERVER_MAP_PATH_KEY = "mapserver.map.path"; - /** - * - */ public static final Paint DEFAULT_VERTICAL_CROSS_SECTION_GROUND_FILL = new Color(0x7c8683); - /** - * - */ public GNVArtifactContext() { super(); log.debug("GNVArtifactContext.Constructor"); } - /** - * - * @param config - */ public GNVArtifactContext(Document config) { super(config); log.debug("GNVArtifactContext.Constructor(config)"); } - } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java Mon Apr 12 06:59:33 2010 +0000 @@ -75,9 +75,6 @@ public static final String XPATH_SETUP_PARAMETER_NODES = "/art:action/art:factory/art:parameter"; - /** - * - */ public static final String XFORM_URL = "http://www.w3.org/2002/xforms"; /** @@ -151,7 +148,7 @@ /** * - * @param products + * @param products Insert a bunch of products. */ public void setProducts(Map products) { this.products = products; @@ -220,9 +217,9 @@ * was sucessfully called before, this artifact is replaced with a concrete * product artifact. * - * @param target - * @param context - * @return + * @param target The advance document. + * @param context The CallContext. + * @return a document with an error or success message. */ @Override public Document advance(Document target, CallContext context) { @@ -290,9 +287,9 @@ * Create a describe document including the user interface description. The * user gets the choice to select a product supported by the current fis. * - * @param data - * @param context - * @return + * @param data The describe document. + * @param context The CallContext. + * @return A document with an error or success message. */ @Override public Document describe(Document data, CallContext context) { @@ -380,9 +377,9 @@ /** * Append products to the describe document. * - * @param document - * @param parent - * @param context + * @param document The describe document. + * @param parent The node the products should be appended to. + * @param context The CallContext object. */ protected void appendProducts( Document document, @@ -413,9 +410,9 @@ * Append the product select box to the user interface description of the * describe document. * - * @param document - * @param node - * @param callMeta + * @param document The describe document. + * @param node The node the products should be appended to. + * @param callMeta The CallMeta object. */ protected void appendSelectProducts( Document document, @@ -470,9 +467,9 @@ /** * Create a feed document. * - * @param uuid - * @param hash - * @return + * @param uuid The UUID of the current artifact. + * @param hash The hash of the current artifact. + * @return the feed document. */ protected Document feedDocument(String uuid, String hash) { Document document = XMLUtils.newDocument(); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/DefaultProduct.java Mon Apr 12 06:59:33 2010 +0000 @@ -42,21 +42,21 @@ } /** - * @return + * @return the name if this product. */ public String getName() { return this.name; } /** - * @return + * @return the input data. */ public Collection getParameter() { return this.parameter; } /** - * @return + * @return the artifact factory. */ public String getArtifactFactory() { return this.artifactFactory; diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java Mon Apr 12 06:59:33 2010 +0000 @@ -92,13 +92,6 @@ super(); } - /** - * @param data - * @param globalContext - * @param callMeta - * @return - * @see de.intevation.artifactdatabase.DefaultService#process(org.w3c.dom.Document, java.lang.Object, de.intevation.artifacts.CallMeta) - */ @Override @SuppressWarnings({"static-access", "static-access"}) public Document process(Document data, Object globalContext, diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultLayer.java Mon Apr 12 06:59:33 2010 +0000 @@ -34,28 +34,28 @@ /** - * @return + * @return the id. */ public String getID() { return this.id; } /** - * @return + * @return the name. */ public String getName() { return this.name; } /** - * @return + * @return true, if this is a group layer. */ public boolean isGroupLayer() { return this.groupLayer; } /** - * @return + * @return the parent id. */ public String parentID() { return this.parentId; diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultMapService.java Mon Apr 12 06:59:33 2010 +0000 @@ -34,33 +34,20 @@ this.url = url; } - /** - * @return - */ public String getID() { return this.id; } - /** - * @return - */ public Collection getLayer() { return this.layer; } - /** - * @return - */ public String getType() { return this.type; } - /** - * @return - */ public String getURL() { return this.url; } - } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/DefaultParameter.java Mon Apr 12 06:59:33 2010 +0000 @@ -23,19 +23,12 @@ this.name = name; } - /** - * @return - */ public String getID() { return this.id; } - /** - * @return - */ public String getName() { return this.name; } - } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractXYLineChart.java Mon Apr 12 06:59:33 2010 +0000 @@ -70,7 +70,6 @@ /** * Field of supported colors used for lines and data points in charts. - * Colors are: {@value}. */ protected static Color[] COLOR = { Color.black, Color.red, Color.green, Color.blue, Color.yellow, @@ -83,7 +82,7 @@ protected static int nextColor = 0; /** - * Default PlotOrientation. Its value is {@value}. + * Default PlotOrientation. */ protected PlotOrientation PLOT_ORIENTATION = PlotOrientation.VERTICAL; @@ -172,9 +171,6 @@ } - /** - * @see de.intevation.gnv.chart.AbstractChart#initChart() - */ protected void initChart() { chart = ChartFactory.createXYLineChart( labels.getTitle(), @@ -191,15 +187,12 @@ /** * Method used to adjust the axes after chart generation. Methods for i18n - * support ({@link #localizeDomainAxis and {@link #localizeRangeAxis) are - * called and axes of this series are expanded ({@link org.jfree.data.Range#expand( - * Range, double, double}). + * support ({@link #localizeDomainAxis} and {@link #localizeRangeAxis}) are + * called and axes of this series are expanded. * * @param seriesKey Identifier of an axis which have to be adjusted. * @param idx Set the axis identified by seriesKey to position * idx. - * - * @see org.jfree.data.Range#expand(Range, double, double) */ protected void prepareAxis(String seriesKey, int idx) { log.debug("prepare axis of xychart"); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/chart/DefaultHistogram.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/DefaultHistogram.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/DefaultHistogram.java Mon Apr 12 06:59:33 2010 +0000 @@ -90,9 +90,6 @@ } - /** - * @see de.intevation.gnv.chart.AbstractHistogram#applyDatasets() - */ @Override protected void applyDatasets() { XYPlot plot = (XYPlot) chart.getPlot(); @@ -206,7 +203,7 @@ /** * Serves the number of bins depending on a given width for each bin, but - * maximum bin count is limited by {@link MAXIMAL_BINS}. + * maximum bin count is limited by {@link #MAXIMAL_BINS}. * * @param values All values in this histogram * diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/HorizontalProfileChart.java Mon Apr 12 06:59:33 2010 +0000 @@ -91,9 +91,6 @@ } - /** - * @see de.intevation.gnv.chart.VerticalProfileChart#getValue(Result) - */ @Override protected Object getValue(Result row) { try { @@ -106,10 +103,6 @@ } - /** - * @see de.intevation.gnv.chart.VerticalProfileChart#gapDetection(Result, - * Series, int, int) - */ @Override protected void gapDetection( Result[] results, @@ -144,9 +137,6 @@ } - /** - * @see de.intevation.gnv.chart.AbstractXYLineChart(Result, Series) - */ @Override protected void addValue(Result row, Series series) { double distance = 0; @@ -173,11 +163,6 @@ } - - /** - * @see de.intevation.gnv.chart.AbstractXYLineChart#addSeries(Series, - * String, int) - */ @Override protected void addSeries(Series series, String label, int idx) { super.addSeries(series, label, idx); @@ -187,10 +172,6 @@ } - /** - * @see de.intevation.gnv.chart.VerticalProfileChart#prepareRangeAxis(String, - * int) - */ @Override protected void prepareRangeAxis(String seriesKey, int idx) { return; @@ -198,11 +179,6 @@ } - /** - * @param value - * @see de.intevation.gnv.chart.VerticalProfileChart#storeMaxValue(Map, - * Object, String) - */ @Override protected void storeMaxValue(Map values, Object value, String parameter) { return; @@ -210,10 +186,6 @@ } - /** - * @see de.intevation.gnv.chart.AbstractXYLineChart#createSeriesName(String, - * String, String) - */ @Override protected String createSeriesName( String breakPoint1, @@ -230,10 +202,6 @@ } - /** - * @see de.intevation.gnv.chart.VerticalProfileChart#addGapsOnGrid(Result[], - * Series, int, int) - */ @Override protected void addGapsOnGrid( Result[] results, @@ -418,10 +386,7 @@ return (smallDelta > (3.0 / (count - 1) * delta)); } - /** - * @see de.intevation.gnv.chart.VerticalProfileChart#getDependendAxisName(Result, - * Result) - */ + @Override protected String getDependendAxisName(Result first, Result second) { if (first.getInteger("IPOSITION") == second.getInteger("IPOSITION")) diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/VerticalProfileChart.java Mon Apr 12 06:59:33 2010 +0000 @@ -52,8 +52,7 @@ protected final double PERCENTAGE = 5.0; /** - * Constnat used for gap detection in @see #gridDetection. Its value is - * {@value}. + * Constnat used for gap detection in @see #gridDetection. */ protected final double GAP_MAX_LEVEL = Math.sqrt(2.0); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ChartExportHelper.java Mon Apr 12 06:59:33 2010 +0000 @@ -136,7 +136,7 @@ * * @param out OutputStream * @param histograms Array of {@link de.intevation.gnv.chart.Chart} - * @param encoding Encoding, defaults to {@link DEFAULT_ENCODING} if null + * @param encoding Encoding, defaults to {@link #DEFAULT_ENCODING} if null * @param width Width the svg used to be * @param height Height the svg used to be */ @@ -181,7 +181,7 @@ * * @param out OutputStream * @param chart JFreeChart to be exported - * @param encoding Encoding, defaults to {@link DEFAULT_ENCODING} if null + * @param encoding Encoding, defaults to {@link #DEFAULT_ENCODING} if null * @param width Width the svg used to be * @param height Height the svg used to be */ @@ -221,7 +221,7 @@ * @param out OutputStream * @param chart JFreeChart * @param pageFormat String to specify a page format, {@link - * DEFAULT_PAGE_SIZE} is used if no pageFormat is given + * #DEFAULT_PAGE_SIZE} is used if no pageFormat is given * @param landscape If this is true, the pdf is delivered in landscape * format * @param marginLeft Space to left border @@ -301,7 +301,7 @@ * @param out OutputStream * @param histograms JFreeChart histograms * @param pageFormat String to specify a page format, {@link - * DEFAULT_PAGE_SIZE} is used if no pageFormat is given + * #DEFAULT_PAGE_SIZE} is used if no pageFormat is given * @param landscape If this is true, the pdf is delivered in landscape * format * @param marginLeft Space to left border diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/DefaultExport.java Mon Apr 12 06:59:33 2010 +0000 @@ -48,7 +48,7 @@ * This method writes data stored in result into a CSV document * using writer. * - * @param profile {@link #Profile} used to specify the format and columns. + * @param profile Profile used to specify the format and columns. * @param result Collection storing the required data. * @param writer CSVWriter to write the csv document. * diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ODVExport.java Mon Apr 12 06:59:33 2010 +0000 @@ -52,10 +52,7 @@ this.startTime = startTime; } - /** - * @see de.intevation.gnv.exports.Export#writeData(Profile, Collection, - * CSVWriter) - */ + @Override protected void writeData(Profile profile, Collection result, CSVWriter writer) throws StateException { diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/exports/ShapeDataCollector.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ShapeDataCollector.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/ShapeDataCollector.java Mon Apr 12 06:59:33 2010 +0000 @@ -12,7 +12,7 @@ import org.apache.log4j.Logger; /** - * This class is a specialization of {@link #DefaultDataCollector}. The + * This class is a specialization of DefaultDataCollector. The * difference between these classes is, that this class extracts points served * by a wkt string. * diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/CompactXYItems.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/CompactXYItems.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/CompactXYItems.java Mon Apr 12 06:59:33 2010 +0000 @@ -78,7 +78,7 @@ /** * - * @return + * @return the number of data points. */ public int size() { return data.length >> 1; @@ -88,7 +88,7 @@ * Retrieves the bounding box spaned by the coordinates in the data array. * * @param bbox - * @return + * @return the calculated bounding box. */ public double [] calculateBoundingBox(double [] bbox) { for (int i = 0; i < data.length;) { diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/LevelOrderIndices.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/LevelOrderIndices.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/LevelOrderIndices.java Mon Apr 12 06:59:33 2010 +0000 @@ -7,56 +7,32 @@ */ public class LevelOrderIndices { - /** - * - */ public interface Visitor { - /** - * - * @param index - * @return - */ + Object visit(int index); } - /** - * - */ + protected int from; - /** - * - */ + protected int to; - /** - * - */ + public LevelOrderIndices() { } - /** - * - * @param to - */ + public LevelOrderIndices(int to) { this(0, to); } - /** - * - * @param from - * @param to - */ + public LevelOrderIndices(int from, int to) { this.from = Math.min(from, to); this.to = Math.max(from, to); } - /** - * - * @param visitor - * @return - */ + public Object visit(Visitor visitor) { LinkedList queue = new LinkedList(); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java Mon Apr 12 06:59:33 2010 +0000 @@ -41,14 +41,8 @@ public class PolygonPlot extends Plot { - /** - * - */ public static final String PLOT_TYPE = "PolygonPlot"; - /** - * - */ public static final PlotOrientation DEFAULT_PLOT_ORIENTATION = PlotOrientation.VERTICAL; @@ -77,7 +71,6 @@ /** - * * @param dataset Dataset containing polygons. * @param renderer The renderer used to draw polygons. * @param orientation The orientation used for this plot. @@ -92,7 +85,6 @@ /** - * * @param dataset Dataset containing polygons. * @param renderer The renderer used to draw polygons. * @param domainAxis The x axis. @@ -138,9 +130,6 @@ } - /** - * - */ public void configureDomainAxis() { // we just have 1 dataset Range domainAxisRange = getDataset().getDomainBounds(); @@ -155,47 +144,26 @@ } } - /** - * - * @return - */ public ValueAxis getDomainAxis() { return getDomainAxis(0); } - /** - * - * @param index - * @return - */ public ValueAxis getDomainAxis(int index) { return index < domainAxes.size() ? (ValueAxis)domainAxes.get(index) : null; } - /** - * - * @return - */ public ValueAxis getRangeAxis() { return getRangeAxis(0); } - /** - * - * @param index - * @return - */ public ValueAxis getRangeAxis(int index) { return index < rangeAxes.size() ? (ValueAxis)rangeAxes.get(index) : null; } - /** - * - */ public void configureRangeAxis() { // we just have 1 dataset Range rangeAxisRange = getDataset().getRangeBounds(); @@ -210,29 +178,14 @@ } } - - /** - * - * @return - */ public PolygonDataset getDataset(){ return this.dataset; } - - /** - * - * @return - */ public String getPlotType() { return PLOT_TYPE; } - - /** - * - * @param dataset - */ public void setDataset(PolygonDataset dataset) { this.dataset = dataset; } @@ -405,12 +358,6 @@ } - /** - * - * @param g2 - * @param plotArea - * @return - */ private AxisSpace calculateAxisSpace(Graphics2D g2, Rectangle2D plotArea) { AxisSpace space = new AxisSpace(); space = calculateRangeAxisSpace(g2, plotArea, space); @@ -421,13 +368,6 @@ } - /** - * - * @param g2 - * @param plotArea - * @param space - * @return - */ private AxisSpace calculateDomainAxisSpace( Graphics2D g2, Rectangle2D plotArea, @@ -449,13 +389,6 @@ } - /** - * - * @param g2 - * @param plotArea - * @param space - * @return - */ private AxisSpace calculateRangeAxisSpace( Graphics2D g2, Rectangle2D plotArea, @@ -477,10 +410,6 @@ } - /** - * - * @return - */ public RectangleEdge getDomainAxisEdge() { return Plot.resolveDomainAxisLocation( getDomainAxisLocation(), orientation @@ -488,11 +417,6 @@ } - /** - * - * @param idx - * @return - */ public RectangleEdge getDomainAxisEdge(int idx) { AxisLocation location = getDomainAxisLocation(idx); RectangleEdge result = Plot.resolveDomainAxisLocation( @@ -506,10 +430,6 @@ } - /** - * - * @return - */ public RectangleEdge getRangeAxisEdge() { return Plot.resolveRangeAxisLocation( getRangeAxisLocation(), orientation @@ -517,11 +437,6 @@ } - /** - * - * @param idx - * @return - */ public RectangleEdge getRangeAxisEdge(int idx) { AxisLocation location = getRangeAxisLocation(idx); RectangleEdge result = Plot.resolveRangeAxisLocation( @@ -536,20 +451,11 @@ } - /** - * - * @return - */ public AxisLocation getDomainAxisLocation() { return (AxisLocation) domainAxisLocation.get(0); } - /** - * - * @param idx - * @return - */ public AxisLocation getDomainAxisLocation(int idx) { if (idx < domainAxisLocation.size()) return (AxisLocation) domainAxisLocation.get(idx); @@ -558,20 +464,11 @@ } - /** - * - * @return - */ public AxisLocation getRangeAxisLocation() { return (AxisLocation) rangeAxisLocation.get(0); } - /** - * - * @param idx - * @return - */ public AxisLocation getRangeAxisLocation(int idx) { if (idx < rangeAxisLocation.size()) return (AxisLocation) rangeAxisLocation.get(idx); @@ -581,8 +478,6 @@ /** - * - * @param dataset * @return true, if dataset is null or if it does not contain any * PolygonSeries, otherwise false. */ diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonRenderer.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonRenderer.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonRenderer.java Mon Apr 12 06:59:33 2010 +0000 @@ -92,28 +92,16 @@ public static final PolygonSeriesLabelGenerator DEFAULT_LABEL_GENERATOR_INSTANCE = new DefaultLabelGenerator(); - /** - * - */ protected PaintLookup lookup; - /** - * - */ + protected PolygonSeriesLabelGenerator labelGenerator; - /** - * - * @param lookup - */ + public PolygonRenderer(PaintLookup lookup) { this(lookup, null); } - /** - * - * @param lookup - * @param labelGenerator - */ + public PolygonRenderer( PaintLookup lookup, PolygonSeriesLabelGenerator labelGenerator @@ -127,10 +115,6 @@ * the given graphics object. If a polygon has no attribute 'fill', we * expect that it is a line, otherwise the polygon is filled. * - * @param graphics - * @param plot - * @param area - * @param dataset */ public void drawPolygons( Graphics2D graphics, @@ -163,10 +147,6 @@ * Draw labels at each item of a series in the given dataset. If the series * has no label attritue, no label is drawn. * - * @param graphics - * @param plot - * @param area - * @param dataset */ public void drawLabels( final Graphics2D graphics, @@ -241,7 +221,7 @@ * @param area The boundary. * @param series The series storing the items. * @param close Specifies if the polygon should be closed or not. - * @return + * @return the constructed shape. */ protected Shape constructShape( PolygonPlot plot, @@ -282,9 +262,6 @@ /** * Retrieves the bounding box of a dataset. - * - * @param dataset - * @return */ public Rectangle2D getBoundingBox(PolygonDataset dataset) { Rectangle2D bbox = null; @@ -311,7 +288,6 @@ /** * - * @param series * @return the bounds of a series. */ public Rectangle2D getBounds(PolygonSeries series) { diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonSeries.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonSeries.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonSeries.java Mon Apr 12 06:59:33 2010 +0000 @@ -88,26 +88,16 @@ } - /** - * - * @param rings - */ public void setRings(CompactXYItems [] rings) { this.rings = rings; } - /** - * - * @return - */ + public CompactXYItems [] getRings() { return rings; } - /** - * - * @param newRing - */ + public void addRing(CompactXYItems newRing) { if (rings == null) { rings = new CompactXYItems [] { newRing }; @@ -120,10 +110,7 @@ } } - /** - * - * @param newRings - */ + public void addRings(CompactXYItems [] newRings) { if (newRings == null || newRings.length == 0) { return; @@ -140,61 +127,32 @@ } } - /** - * - * @param key - * @return - */ + public Object getAttribute(Object key) { return attributes.get(key); } - /** - * - * @param key - * @param value - * @return - */ public Object setAttribute(Object key, Object value) { return attributes.put(key, value); } - /** - * - * @return - */ public int getItemCount() { return rings != null ? rings.length : 0; } - /** - * - * @param idx - * @return - */ public CompactXYItems getItem(int idx) { return rings[idx]; } - /** - * - * @param key - * @return - */ public Object removeAttribute(Object key) { return attributes.remove(key); } - /** - * - * @param key - * @return - */ public boolean hasAttribute(Object key) { return attributes.containsKey(key); } diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/AreaInterpolation.java Mon Apr 12 06:59:33 2010 +0000 @@ -62,7 +62,7 @@ /** * The generated raster. - * @return + * @return the raster. */ public double [] getRaster() { return raster; diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/math/GridCell.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/math/GridCell.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/math/GridCell.java Mon Apr 12 06:59:33 2010 +0000 @@ -149,7 +149,7 @@ /** * Returns the envelope of the four point polygon. - * @return + * @return the envelope. */ public Envelope getEnvelope() { return polygon.getEnvelopeInternal(); @@ -158,7 +158,8 @@ /** * Test if a given point is inside this grid cell. * @param coord - * @return + * @return true, if this grid cell contains the given point - otherwise + * false. */ public boolean contains(Geometry coord) { return polygon.contains(coord); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/state/CoordinateSelectionState.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/CoordinateSelectionState.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/CoordinateSelectionState.java Mon Apr 12 06:59:33 2010 +0000 @@ -82,10 +82,7 @@ return describeData; } - /** - * @param value - * @return - */ + @Override protected String prepareInputData4RegionDBQuery(String value) { log.debug("CoordinateSelectionState.prepareInputData4RegionDBQuery"); @@ -117,10 +114,7 @@ } - /** - * @param valueid - * @param keyid - */ + @Override protected NamedCollection extractKVP( Collection result, @@ -160,9 +154,7 @@ return WKTUtils.toText(wkt); } - /** - * @param configuration - */ + @Override public void setup(Node configuration) { super.setup(configuration); diff -r 9d427dd2a96a -r 22c18083225e gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultAutoResumeState.java --- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultAutoResumeState.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultAutoResumeState.java Mon Apr 12 06:59:33 2010 +0000 @@ -27,24 +27,12 @@ } - /** - * - * @param result - * @param uuid - * @return - */ @Override protected List