//This file is part of SECONDO.

//Copyright (C) 2004, University in Hagen, Department of Computer Science, 
//Database Systems for New Applications.

//SECONDO is free software; you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation; either version 2 of the License, or
//(at your option) any later version.

//SECONDO is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with SECONDO; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

package  viewer.hoese;

import  sj.lang.ListExpr;
import viewer.HoeseViewer;

/** This class need to be implemented by displayclasses of datatypes directly or 
 * indirectly by overwriting a class that implements this one. 
 */
public interface DsplBase {

  /**
   * In relations it is neccessary to get the name of the attribute of this datatype instance in
   * a tuple.
   * @return attribute name
   */
  public String getAttrName ();



  /**
   * If this datatype shouldn't be displayed in the default 2D-geographical viewer this
   * method returns the specialized frame, which can do this.
   * @return An instance of a SecondoFrame, with the ability of displaying this type.
   * @see generic.SecondoFrame
   */
  public SecondoFrame getFrame ();



  /**
   * This method is used to analyse the type and value in NestedList format and build
   * up the intern datastructures for this type. An alphanumeric representation is 
   * neccessary for the displaying this type in the queryresultlist.
   * @param name The name of the value, e.g. the attribute name
   * @param nameWidth for formatted output 
   * @param type A ListExpr describing the data type 
   * @param value ListExpr describing the value of the object
   * @param qr The queryresultlist to add alphanumeric representation
   * @see generic.QueryResult
   * @see sj.lang.ListExpr
   */
   public void init (String Name, int nameWidth, int indent,
                     ListExpr type,
                     ListExpr value,
                      QueryResult qr);


  /**
   * Sets the visibility of an object 
   * @param b true=show false=hide
   */
  public void setVisible (boolean b);



  /**
   * Gets the visibility of an object
   * @return true if visible, false if not
   */
  public boolean getVisible ();



  /**
   * Sets the select status of an object, textual or graphical.
   * @param b true if selected, false if not.
   */
  public void setSelected (boolean b);



  /**
   * Gets the select status of an object, textual or graphical
   * @return true if selected, false if not
   */
  public boolean getSelected ();




}