io.github.repir.Repository.StoredDynamicFeature Maven / Gradle / Ivy

Go to download
package io.github.repir.Repository;

import java.util.Collection;
import io.github.repir.tools.io.Datafile;
import io.github.repir.tools.io.struct.StructuredFileKeyValueRecord;
import io.github.repir.tools.io.struct.StructuredFileKeyInterface;
import io.github.repir.tools.lib.Log;
import io.github.repir.tools.lib.PrintTools;

/**
 * Generic class for Features that are not static and must be stored dynamically.
 * 
 * The feature's data is stored in a file that implemented the StructuredFileKeyInterface.
 * The generic class considers separate Key and KeyValue records, allowing
 * an implementation to choose between a separate StructuredFileKey, which allows
 * efficient access by loading only the small keys and reading only the large 
 * values from disk when needed, or for small amounts of data StructuredFileKeyValue
 * in which Key and Value are stored combined which is allows for fast resident 
 * access to keys and values.
 * 
 * if the configuration contains .suffix (all lowercase!) then
 * the file used is append with "." and the suffix to allow to use a different version
 * of a file.
 * @author jeroen
 * @param  FileType that extends RecordIdentity
 * @param 
 * @param  Data type of the feature
 */
public abstract class StoredDynamicFeature, R extends StructuredFileKeyValueRecord> extends StoredFeature {

   public static Log log = new Log(StoredDynamicFeature.class);
   private F file;
   int recordcount = 0;

   public StoredDynamicFeature(Repository repository) {
      super(repository);
   }
   
   public StoredDynamicFeature(Repository repository, String field) {
      super(repository, field);
   }
   
   @Override
   public int hashCode() {
      return getClass().getCanonicalName().hashCode();
   }

   @Override
   public boolean equals( Object o ) {
      return getClass().getCanonicalName().equals(o.getClass().getCanonicalName());
   }

   public Collection getKeys() {
      return getFile().getKeys();
   }
   
   @Override
   public F getFile() {
      if (file == null)
         file = createFile();
      return file;
   }

   public boolean lock() {
      return getFile().lock();
   }
   
   public void unlock() {
      getFile().unlock();
   }
   
   public void setKeyBufferSize(int size) {
      getFile().setKeyBufferSize(size);
   }
   
   public void setDataBufferSize(int size) {
      getFile().setDataBufferSize(size);
   }
   
   public int getKeyBufferSize() {
      return getFile().getKeyBufferSize();
   }
   
   public int getDataBufferSize() {
      return getFile().getDataBufferSize();
   }

   public void reuse() {
      log.fatal("reuse not yet implemented");
   }

   public void remove( Iterable records ) {
      getFile().remove(records);
   }
   
   protected F createFile() {
      Datafile df = getStoredFeatureFile();
      return createFile(df);
   }
   
   public abstract F createFile(Datafile df);
   
   public R newRecord() {
      return getFile().newRecord();
   }
   
   public R find( R r ) {
      openRead();
      return (R)file.find(r);
   }
   
   public boolean exists( R r ) {
      openRead();
      return file.exists(r);
   }
   
   @Override
   public void openRead() {
      getFile().openRead();
   }
   
   @Override
   public void closeRead() {
      getFile().closeRead();
   }
   
   public void openWrite() {
      if (getFile().hasLock() || getFile().lock())
         getFile().openAppend();
   }
   
   public void openWriteNew() {
      if (getFile().hasLock() || getFile().lock())
         getFile().openWrite();
   }
   
   public void write( R r ) {
      file.write(r);
   }
   
   public void closeWrite() {
      getFile().closeWrite();
      getFile().unlock();
   }
   
   @Override
   public Datafile getStoredFeatureFile() {
      Datafile datafile;
      String name = getCanonicalName();
      name = name.substring(name.indexOf('.')+1);
      name = name.replaceFirst(":", ".");
      String path = repository.configuredString(name.toLowerCase() + ".path");
      if (path != null && path.length() > 0)
         datafile = new Datafile( repository.fs, path);
      else
         datafile = repository.basedir.getFile(PrintTools.sprintf("dynamic/%s.%s", repository.getPrefix(), getFileNameSuffix()));
      return datafile;
   }
}