dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java annotate

annotate gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java @ 1115:f953c9a559d8

Added license file and license headers. gnv-artifacts/trunk@1260 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Tue, 02 Nov 2010 17:46:55 +0000
parents	05bf8534a35a
children

rev	line source
1115 f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	1 /*
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	2 * Copyright (c) 2010 by Intevation GmbH
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	3 *
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	4 * This program is free software under the LGPL (>=v2.1)
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	5 * Read the file LGPL.txt coming with the software for details
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	6 * or visit http://www.gnu.org/licenses/ if it does not exist.
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	7 */
f953c9a559d8 Added license file and license headers. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 836 diff changeset	8
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	9 package de.intevation.gnv.state;
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	10
480 211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	11 import de.intevation.artifacts.CallContext;
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	12
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	13 import de.intevation.gnv.state.exception.StateException;
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	14
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	15 import java.io.OutputStream;
480 211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	16
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	17 import java.util.Collection;
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	18
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	19 import org.w3c.dom.Document;
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	20
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	21 /**
796 a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	22 * This is the interface description of an output state. Currently, there are
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	23 * two methods defined:<br>
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	24 * <ol>
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	25 * <li>out(): To start an output of the current state.</li>
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	26 * <li>getOutputModes(): To retrieve a list of possible output modes.</li>
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	27 * </ol>
803 feae2f9d6c6f Removed trailing whitespace. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 796 diff changeset	28 *
780 c4156275c1e1 Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>' Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 779 diff changeset	29 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	30 */
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 480 diff changeset	31 public interface OutputState
480 211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	32 extends State
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	33 {
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	34
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	35 /**
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	36 * Returns the Rendered Result of an State.
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 480 diff changeset	37 *
796 a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	38 * @param format
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	39 * @param inputData
a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	40 * @param outputStream
803 feae2f9d6c6f Removed trailing whitespace. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 796 diff changeset	41 * @param uuid
796 a5526908f92f Added javadoc in state package. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 780 diff changeset	42 * @param callContext
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	43 * @throws StateException
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	44 */
358 2f7a28f211c7 Fetch ChartTheme from CallContext instead of creating it each time before creating a chart. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 335 diff changeset	45 public void out(
480 211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	46 Document format,
358 2f7a28f211c7 Fetch ChartTheme from CallContext instead of creating it each time before creating a chart. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 335 diff changeset	47 Collection<InputData> inputData,
480 211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	48 OutputStream outputStream,
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	49 String uuid,
211cad2fb5ba Rebased "Horizonalschnitte" to own state class to break from the not Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 358 diff changeset	50 CallContext callContext
358 2f7a28f211c7 Fetch ChartTheme from CallContext instead of creating it each time before creating a chart. Ingo Weinzierl <ingo.weinzierl@intevation.de> parents: 335 diff changeset	51 ) throws StateException;
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	52
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	53 /**
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	54 * Delivers the provided OutputModes of an State
778 9a828e5a2390 Removed trailing whitespace Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 480 diff changeset	55 *
335 e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	56 * @return the provided OutputModes of an State
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	57 */
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	58 public Collection<OutputMode> getOutputModes();
e964a3d8f7bc Some Refactoring work done. Tim Englich <tim.englich@intevation.de> parents: diff changeset	59 }
836 05bf8534a35a Using unix line endings only. Sascha L. Teichmann <sascha.teichmann@intevation.de> parents: 803 diff changeset	60 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

Mercurial > dive4elements > gnv-client

annotate gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java @ 1115:f953c9a559d8