Logo
Distributed Genetic Programming Framework
print print

File org.dgpf.search.api.HaltParameters.java

Here you can find all the information about the file org.dgpf.search.api.HaltParameters.java. You may explore it here or download it onto your local disk.
/*
 * Copyright (c) 2006 Thomas Weise
 * 
 * E-Mail           : tweise@gmx.de
 * Creation Date    : 2006-03-30 10:49:53
 * Original Filename: org.dgpf.search.api.HaltParameters.java
 * Version          : 2.0.0
 * Last modification: 2006-05-08
 *                by: Thomas Weise
 * 
 * License          : GNU LESSER GENERAL PUBLIC LICENSE
 *                    Version 2.1, February 1999
 *                    You should have received a copy of this license along
 *                    with this library; if not, write to the Free Software
 *                    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *                    MA 02111-1307, USA or download the license under
 *                    http://www.gnu.org/copyleft/lesser.html.
 *                    
 * Warranty         : This software is provided "as is" without any
 *                    warranty; without even the implied warranty of
 *                    merchantability or fitness for a particular purpose.
 *                    See the Gnu Lesser General Public License for more
 *                    details.
 */

 
package org.dgpf.search.api;

import org.sfc.id.ID;
import org.sfc.id.IDManager;

/**
 * The search halt parameters can be used to specify when a search should
 * stop all its work.
 * 
 * @author Thomas Weise
 */

public abstract class HaltParameters  extends     SearchAdaptable
  {
/**
 * The serial version uid.
 */

  private static final long serialVersionUID = 1;
  

/**
 * The manager for the halt-ids.
 */

  protected static  final IDManager<String, HaltType> MANAGER = 
    new IDManager<String, HaltType>();
  
/**
 * This value is returned by <code>should_halt()</code> if the search
 * engine should go on processing.
 * @see #should_halt(SearchState)
 */

  protected static  final HaltType  GO_ON     = new HaltType("go_on");

/**
 * This value is returned by <code>should_halt()</code> if only the local
 * search engine should be aborted.
 * @see #should_halt(SearchState)
 */

  protected static  final HaltType  ABORT     = new HaltType("abort");

/**
 * This value is returned by <code>should_halt()</code> if the whole
 * search should end. 
 * @see #should_halt(SearchState)
 */

  protected static  final HaltType  SHUTDOWN  = new HaltType("shutdown");

  
/**
 * Create a new instance of <code>HaltParameters</code>.
 */

  protected HaltParameters ()
    {
    super();
    }
  

/**
 * Check wether at least one of the halt criterions is met. This method
 * tells the search engine wether it should continue processing
 * (<code>GO_ON</code>), wether it should abort locally (<code>ABORT</code>)
 * or if all search engines in the network should stop working.
 * (<code>SHUTDOWN</code>)
 * @param p_state     The state of the search engine.
 * @return  <code>GO_ON</code> if the searching should continue,
 *          <code>ABORT</code> if the local search engine should abort,
 *          <code>SHUTDOWN</code> if all searching activities should end
 *          throughout the network
 * @see #GO_ON
 * @see #ABORT
 * @see #SHUTDOWN
 */

  protected HaltType should_halt (final SearchState<?> p_state)
    {    
    return GO_ON;
    }
    
  
  
/**
 * This class is used as id for halting.
 *
 * @author Thomas Weise
 */

  protected static  final class HaltType  extends ID<String, HaltType>
    {
/**
 * The serial version uid.
 */

    private static final long serialVersionUID = 1;
    
/**
 * Create a new halt action.
 * @param p_id  The name of the constant.
 */

    HaltType(final String p_id)
      {
      super(p_id, MANAGER);
      }
    
/**
 * Obtain the manager for the ids of this type.
 * @return  The manager for the ids of this type.
 */

    @Override
    protected final IDManager<String,HaltType> get_manager () 
      {
      return MANAGER;
      }
    }
  }

File Information:

file name:HaltParameters.java
package:org.dgpf.search.api
qualified name:org.dgpf.search.api.HaltParameters.java
file type:Java Source File
download location:download http://dgpf.sourceforge.net/source/org/dgpf/search/api/HaltParameters.java
size:3.840 KB (3933 B)
uploaded: 2015-07-22 04:11:00 GMT+0000
last update: 2006-05-26 13:25:42 GMT+0000
last access: 2017-11-17 21:17:57 GMT+0000

statistics online since 2006-01-02.   RSS Feed
Contact us by sending an email to tweise@gmx.de to receive further information, to report errors, or to join our project.
All content on this site (http://dgpf.sourceforge.net/) is LGPL-licensed.
http://dgpf.sourceforge.net/scripts/source/source.php last modified at 2015-07-22 04:10:53 GMT+0000 served at 2017-11-17 21:17:57 GMT+0000.
Valid CSS Valid XHTML 1.1
Valid RSS SourceForge.net Logo