gate.util.persistence.PRPersistence Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 *
 *  Valentin Tablan 26/10/2001
 *
 *  $Id: PRPersistence.java 20046 2017-02-01 10:10:20Z markagreenwood $
 *
 */
package gate.util.persistence;

import gate.Factory;
import gate.FeatureMap;
import gate.Gate;
import gate.ProcessingResource;
import gate.Resource;
import gate.creole.Parameter;
import gate.creole.ParameterException;
import gate.creole.ParameterList;
import gate.creole.ResourceData;
import gate.creole.ResourceInstantiationException;
import gate.persist.PersistenceException;

import java.util.Iterator;
import java.util.List;


public class PRPersistence extends ResourcePersistence {
  /**
   * Populates this Persistence with the data that needs to be stored from the
   * original source object.
   */
  @Override
  public void extractDataFromSource(Object source)throws PersistenceException{
    if(! (source instanceof ProcessingResource)){
      throw new UnsupportedOperationException(
                getClass().getName() + " can only be used for " +
                ProcessingResource.class.getName() +
                " objects!\n" + source.getClass().getName() +
                " is not a " + ProcessingResource.class.getName());
    }

    super.extractDataFromSource(source);
    Resource res = (Resource)source;

    ResourceData rData = Gate.getCreoleRegister().get(res.getClass().getName());
    if(rData == null) throw new PersistenceException(
                                "Could not find CREOLE data for " +
                                res.getClass().getName());

    //now get the runtime params
    ParameterList params = rData.getParameterList();
    try{
      //get the values for the init time parameters
      runtimeParams = Factory.newFeatureMap();
      //this is a list of lists
      Iterator> parDisjIter = params.getRuntimeParameters().iterator();
      while(parDisjIter.hasNext()){
        Iterator parIter = parDisjIter.next().iterator();
        while(parIter.hasNext()){
          Parameter parameter = parIter.next();
          String parName = parameter.getName();
          Object parValue = res.getParameterValue(parName);
          if (storeParameterValue(parValue, parameter.getDefaultValue())) {
        	  ((FeatureMap)runtimeParams).put(parName,parValue);
          }
        }
      }
      runtimeParams = PersistenceManager.
                      getPersistentRepresentation(runtimeParams);
    }catch(ResourceInstantiationException | ParameterException rie){
      throw new PersistenceException(rie);
    }
  }

  /**
   * Creates a new object from the data contained. This new object is supposed
   * to be a copy for the original object used as source for data extraction.
   */
  @Override
  public Object createObject()throws PersistenceException,
                                     ResourceInstantiationException{
    Object res = super.createObject();
    //now add the runtime parameters
    if(runtimeParams != null){
      runtimeParams = PersistenceManager.
                      getTransientRepresentation(
              runtimeParams,containingControllerName,initParamOverrides);
      ((Resource)res).setParameterValues((FeatureMap)runtimeParams);
    }
    return res;
  }

  protected Object runtimeParams;
  static final long serialVersionUID = 2031381604712340552L;
}