Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/state/StateBase.java @ 815:22c18083225e
Removed compiler warnings while JavaDoc generation.
gnv-artifacts/trunk@900 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Mon, 12 Apr 2010 06:59:33 +0000 |
parents | feae2f9d6c6f |
children | 499cfbbb61bc |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/StateBase.java Fri Apr 09 14:34:45 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/StateBase.java Mon Apr 12 06:59:33 2010 +0000 @@ -74,38 +74,20 @@ */ private static Logger log = Logger.getLogger(StateBase.class); - /** - * - */ protected final static String MINVALUEFIELDNAME = "minvalue"; - /** - * - */ + protected final static String MAXVALUEFIELDNAME = "maxvalue"; private final static String NODATASELECTIONKEY = "n/n"; - /** - * - */ public final static String DESCRIBEDATAKEY = "_DESCRIBEDATA"; - /** - * - */ public final static String XPATH_STATIC_UI = "art:static"; - /** - * - */ + public final static String XPATH_DYNAMIC_UI = "art:dynamic"; - /** - * - */ public static final String EXCEPTION_NO_INPUT = "no.input.data"; - /** - * - */ + public static final String EXCEPTION_INVALID_INPUT = "input.is.not.valid"; @@ -114,61 +96,28 @@ private String id = null; - /** - * - */ protected String hash; private String description = null; - /** - * - */ protected String dataName = null; - /** - * - */ protected String preSettingsName = null; - /** - * - */ protected boolean dataMultiSelect = false; - /** - * - */ protected boolean dataNoSelect = false; - /** - * - */ protected String queryID = null; - /** - * - */ protected Collection<String> inputValueNames = null; - /** - * - */ protected Map<String, InputValue> inputValues = null; - /** - * - */ protected State parent = null; - /** - * - */ protected Map<String, InputData> inputData = null; - /** - * - */ protected Map<String, InputData> preSettings = null; /** @@ -178,43 +127,27 @@ super(); } - /** - * @return - */ + public String getID() { return this.id; } - /** - * @return - */ + public String getDescription() { return this.description; } - - /** - * @return - */ public Collection<InputValue> getRequiredInputValues() { return this.inputValues.values(); } - /** - * - * @param uuid - */ public void reset(String uuid) { inputData.remove(dataName); } - /** - * @param configuration - * @see de.intevation.gnv.state.State#setup(org.w3c.dom.Node) - */ public void setup(Node configuration) { this.id = ((Element)configuration).getAttribute("id"); this.description = ((Element)configuration).getAttribute("description"); @@ -268,31 +201,17 @@ } - /** - * @return - * @see de.intevation.gnv.state.State#getParent() - */ + public State getParent() { return this.parent; } - /** - * @param state - * @see de.intevation.gnv.state.State#setParent(de.intevation.gnv.state.State) - */ + public void setParent(State state) { this.parent = state; } - /** - * - * @param context - * @param inputData - * @param uuid - * @return - * @throws StateException - */ public Document feed( CallContext context, Collection<InputData> inputData, @@ -358,33 +277,18 @@ } - /** - * - * @return - */ protected Document feedSuccess() { return ArtifactXMLUtilities.createSuccessReport( "Initialize success", XMLUtils.newDocument()); } - /** - * - * @param msg - * @return - */ protected Document feedFailure(String msg) { return ArtifactXMLUtilities.createInputExceptionReport( msg, XMLUtils.newDocument()); } - /** - * - * @param data - * @param uuid - * @return - */ protected String[] getDescriptionForInputData(InputData data, String uuid) { // there is only one element in the list, so take the first Object obj = getDescibeData(uuid).get(0); @@ -423,12 +327,6 @@ } - /** - * @param inputData - * @param uuid - * @throws StateException - * @see de.intevation.gnv.state.State#putInputData(java.util.Collection) - */ @SuppressWarnings({"static-access", "static-access", "static-access", "static-access"}) public void putInputData(Collection<InputData> inputData, String uuid) throws StateException { @@ -513,31 +411,16 @@ } - /** - * - * @param preSettings - * @see de.intevation.gnv.state.State#setPreSettings(java.util.Map) - */ public void setPreSettings(Map<String, InputData> preSettings) { this.preSettings = preSettings; } - - /** - * - * @return - */ public Map<String, InputData> getPreSettings() { return this.preSettings; } - /** - * - * @param inputData - * @param inputName - * @return - */ + protected String getInputValue4ID(Collection<InputData> inputData, String inputName){ Iterator<InputData> it = inputData.iterator(); while (it.hasNext()) { @@ -550,32 +433,18 @@ } - /** - * @param uuid - * @param context - * @throws StateException - * @see de.intevation.gnv.state.State#advance(java.lang.String, - * de.intevation.artifacts.CallMeta) - */ public void advance(String uuid, CallContext context) throws StateException { } - /** - * - * @param uuid - * @param context - * @throws StateException - */ + public void initialize(String uuid, CallContext context) throws StateException { } - /** - * @return - */ + protected String[] generateFilterValuesFromInputData() { List<String> list = new ArrayList<String>(); Iterator<String> it = this.inputValueNames.iterator(); @@ -608,11 +477,7 @@ return filterValues; } - /** - * - * @param value - * @return - */ + protected String prepareInputData4RegionDBQuery(String value){ return value; } @@ -652,11 +517,7 @@ } - /** - * @param result - * @param uuid - * @return - */ + protected List<Object> purifyResult(Collection<Result> result, String uuid) { List<Object> describeData = new ArrayList<Object>(); @@ -668,12 +529,7 @@ return describeData; } - /** - * @param result - * @param keyid - * @param valueid - * @return - */ + protected NamedCollection<KeyValueDescibeData> extractKVP(Collection<Result> result, String keyid, String valueid) { @@ -736,11 +592,6 @@ } - /** - * - * @param key - * @return - */ public static boolean inBlackList(String key) { int length = BLACKLIST.length; for (int i = 0; i < length; i++) { @@ -752,15 +603,7 @@ return false; } - /** - * @param document - * @param rootNode - * @param context - * @param uuid - * @see de.intevation.gnv.state.State#describe(org.w3c.dom.Document, - * org.w3c.dom.Node, de.intevation.artifacts.CallMeta, - * java.lang.String) - */ + public void describe( Document document, Node rootNode, @@ -806,15 +649,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param dynamic - * @param context - * @param uuid - */ protected void describeDynamic( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -843,15 +677,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param staticNode - * @param context - * @param uuid - */ protected void describeStatic( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -871,14 +696,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param staticNode - * @param callMeta - */ protected void appendToStaticNode( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -932,15 +749,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param dynamicNode - * @param callMeta - * @param o - */ protected void appendToDynamicNode( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -1014,15 +822,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param node - * @param callMeta - * @param o - */ protected void appendMinMaxDescribeData( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -1089,15 +888,6 @@ } - /** - * - * @param artCreator - * @param creator - * @param document - * @param node - * @param callMeta - * @param o - */ protected void appendSingleValueDescribeData( XMLUtils.ElementCreator artCreator, XMLUtils.ElementCreator creator, @@ -1137,29 +927,16 @@ } - /** - * - * @param uuid - */ protected void setHash(String uuid) { this.hash = uuid + id + inputData.hashCode(); } - /** - * - * @return - */ protected String getHash() { return this.hash; } - /** - * @param uuid - * @return - * @see de.intevation.gnv.state.State#getDescibeData() - */ public List<Object> getDescibeData(String uuid) { CacheFactory factory = CacheFactory.getInstance(); if (factory.isInitialized()) { @@ -1210,13 +987,7 @@ return null; } - /** - * - * @param filterValues - * @param uuid - * @return - * @throws QueryException - */ + protected List<Object> queryDatabase(String[] filterValues, String uuid) throws QueryException { Collection<Result> result = null; @@ -1231,28 +1002,17 @@ } - /** - * - * @return - */ + public Map<String, InputData> inputData() { return inputData; } - /** - * @return - * @throws StateException - * @see de.intevation.gnv.state.State#getInputData() - */ + public Collection<InputData> getInputData() throws StateException { return this.inputData != null ? this.inputData.values() : null; } - /** - * - * @param name - * @return - */ + public InputData getInputDataByName(String name) { State state = this; @@ -1268,18 +1028,11 @@ return null; } - /** - * - * @param globalContext - */ + public void endOfLife(Object globalContext) { } - /** - * - * @param context - */ public void cleanup(Object context) { } }