Save This Page
Home » openjdk-7 » net » sf » rvpf » metadata » [javadoc | source]
    1   /**
    2    * Related Values Processing Framework.
    3    * 
    4    * Copyright (C) 2003 Serge Brisson.
    5    * 
    6    * This software is distributable under LGPL license.
    7    * See details at the bottom of this file.
    8    * 
    9    * $Header: /cvsroot/rvpf/RVPF/java/src/net/sf/rvpf/metadata/Point.java,v 1.7 2003/10/24 16:11:27 sfb Exp $
   10    */
   11   package net.sf.rvpf.metadata;
   12   
   13   import java.util.List;
   14   
   15   import net.sf.rvpf.content.Content;
   16   import net.sf.rvpf.processor.engine.Transform;
   17   import net.sf.rvpf.store.Store;
   18   
   19   /** Point.
   20    * <p>
   21    * The Point protocol is used to access the informations of a point definition.
   22    * It is implemented by the {@link net.sf.rvpf.metadata.PointEntity} class.
   23    * 
   24    * @author Serge Brisson
   25    * @version $Revision: 1.7 $
   26    */
   27   public interface Point extends Comparable {
   28   
   29       // Instance Properties.
   30   
   31       /** Gets this Point's Content handling instance.
   32        * <p>
   33        * The Point's Content handling provides normalization / denormalization
   34        * services.
   35        * 
   36        * @return The Content handling instance.
   37        */
   38       Content getContent();
   39   
   40       /** Gets this Point's filters.
   41        * <p>
   42        * The filters allow the filtering of Notice values.
   43        * 
   44        * @return The filters.
   45        */
   46       List getFilters();
   47   
   48       /** Gets this Point's inputs.
   49        * <p>
   50        * The Point's inputs are the points that may trigger a computation of
   51        * this point and / or are needed by this Point's Transform program.
   52        * 
   53        * @return The List of Input points.
   54        */
   55       List getInputs();
   56   
   57       /** Gets this Point's level.
   58        * <p>
   59        * In the context of a Processor, a Point's level determines the
   60        * order of processing within the Processor.
   61        * 
   62        * @return
   63        *      An int where 0 means that the values of this point
   64        *      are not computed here.  Higher values represent the level
   65        *      of dependencies.
   66        */
   67       int getLevel();
   68   
   69       /** Gets this Point's identification.
   70        * <p>
   71        * A Point's identification is either its name or ident when available,
   72        * or its UUID as a String.
   73        * 
   74        * @return The Point's name.
   75        */
   76       String getIdent();
   77   
   78       /** Gets this Point's Params.
   79        * 
   80        * @return The Point's Params.
   81        */
   82       Params getParams();
   83   
   84       /** Gets this Point's dependants.
   85        * <p>
   86        * When a new or updated value of this Point may trigger the computation
   87        * of an other Point and / or this Point's value is used in its
   88        * computation, that other Point is considered a dependant.
   89        * 
   90        * @return A List of Point definitions.
   91        */
   92       List getResults();
   93   
   94       /** Gets this Point's Store.
   95        * 
   96        * @return The definition of the Store holding values for this Point.
   97        */
   98       Store getStore();
   99   
  100       /** Gets this Point's Transform.
  101        * 
  102        * @return The Transform which can compute a value for this Point.
  103        */
  104       Transform getTransform();
  105   
  106       /** Gets this Point's UUID.
  107        * <p>
  108        * A Point's UUID is the logical primary key for that Point's definition.
  109        * 
  110        * @return The Point's UUID.
  111        */
  112       UUID getUUID();
  113   }
  114   
  115   // $Log: Point.java,v $
  116   // Revision 1.7  2003/10/24 16:11:27  sfb
  117   // Added filters.
  118   //
  119   // Revision 1.6  2003/09/19 19:48:22  sfb
  120   // Refactored Behaviour and Relation.
  121   //
  122   
  123   /*
  124    * This is free software; you can redistribute it and/or modify
  125    * it under the terms of the GNU Lesser General Public License
  126    * as published by the Free Software Foundation; either version 2.1
  127    * of the License, or (at your option) any later version.
  128    *
  129    * This software is distributed in the hope that it will be useful,
  130    * but WITHOUT ANY WARRANTY; without even the implied warranty of
  131    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  132    * Lesser General Public License for more details.
  133    *
  134    * You should have received a copy of the GNU Lesser General Public
  135    * License along with this software; if not, write to the Free Software
  136    * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  137    */

Save This Page
Home » openjdk-7 » net » sf » rvpf » metadata » [javadoc | source]