/*
 * Copyright 2011 Corpuslinguistic working group Humboldt University Berlin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package annis.gui.visualizers;

import java.io.OutputStream;
import net.xeoh.plugins.base.Plugin;

/**
 * Base interface for all iframe visualizer plugins
 * @author Thomas Krause <krause@informatik.hu-berlin.>
 */
public interface IFrameVisualizerPlugin extends VisualizerPlugin
{

  /**
   * Writes the final output to passed OutputStream. The stream should remain open.
   * 
   * @param input The input from which the visualization should be generated from
   * @param outstream The OutputStream to be used
   */
  public void writeOutput(VisualizerInput input, OutputStream outstream);

  /**
   * Returns the character endocing for this particular Visualizer output. For more information see {@link javax.servlet.ServletResponse#setCharacterEncoding(String)}.
   * Must be overridden to change default "utf-8".
   * @return the CharacterEncoding
   */
  public String getCharacterEncoding();

  /**
   * Returns the content-type for this particular Visualizer output. For more information see {@link javax.servlet.ServletResponse#setContentType(String)}.
   * Must be overridden to change default "text/html".
   * @return the ContentType
   */
  public String getContentType();
  
  /**
   * Get the shorted name of the linguistic type of this visualizer ("partitur", 
   * "tree", etc.)
   * @return 
   */
  public String getShortName();
  
  /**
   * Return if this visualizer is using the complete text.
   * @return 
   */
  public boolean isUsingText();
}

@@ -788,16 +788,19 @@
 plugins%0A
+ *%0A
  * @auth
@@ -1002,16 +1002,21 @@
 d remain
+%0A   *
  open.%0A 
@@ -1018,17 +1018,16 @@
 en.%0A   *
- 
 %0A   * @p
@@ -1095,16 +1095,21 @@
 enerated
+%0A   *
  from%0A  
@@ -1313,32 +1313,37 @@
 izer output. For
+%0A   *
  more informatio
@@ -1339,32 +1339,37 @@
  information see
+%0A   *
  %7B@link javax.se
@@ -1416,37 +1416,32 @@
 ng(String)%7D.
-%0A   *
  Must be
  overridden 
@@ -1420,32 +1420,37 @@
 tring)%7D. Must be
+%0A   *
  overridden to c
@@ -1472,16 +1472,21 @@
 utf-8%22.%0A
+   *%0A
    * @re
@@ -1638,24 +1638,29 @@
 ut. For more
+%0A   *
  information
@@ -1663,16 +1663,21 @@
 tion see
+%0A   *
  %7B@link 
@@ -1734,21 +1734,16 @@
 g)%7D.
-%0A   *
  Must be
  ove
@@ -1738,16 +1738,21 @@
  Must be
+%0A   *
  overrid
@@ -1786,16 +1786,21 @@
 /html%22.%0A
+   *%0A
    * @re
@@ -1864,172 +1864,8 @@
 ();%0A
-  %0A  /**%0A   * Get the shorted name of the linguistic type of this visualizer (%22partitur%22, %0A   * %22tree%22, etc.)%0A   * @return %0A   */%0A  public String getShortName();%0A  
 %0A  /
@@ -1926,16 +1926,21 @@
 e text.%0A
+   *%0A
    * @re
@@ -1943,17 +1943,16 @@
  @return
- 
 %0A   */%0A 

Delete getShortName() from IFrameVisualizer