de.datexis.annotator.IComponent Maven / Gradle / Ivy

Go to download
package de.datexis.annotator;

import com.google.common.collect.Lists;
import de.datexis.common.Resource;
import de.datexis.encoder.Encoder;
import de.datexis.encoder.IEncoder;
import org.nd4j.shade.jackson.annotation.JsonIgnore;
import org.nd4j.shade.jackson.annotation.JsonIgnoreProperties;
import org.nd4j.shade.jackson.annotation.JsonInclude;

import java.io.IOException;
import java.util.List;

/**
 * Superclass for Components in an Annotator
 * @author Sebastian Arnold 
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public interface IComponent {

  String getName();

  String getId();

  @JsonIgnore
  boolean isModelAvailable();
  
  /**
   * set all child Encoders (input & output) of this IComponent
   */
  default void setEncoders(List encs) {}
  
  /**
   * @return all child Encoders (input & output) of this IComponent
   */
  @JsonIgnore
  default List getEncoders() {
    return Lists.newArrayList();
  }

  /**
	 * Load a pre-trained model
   * @param file The file to load
	 */
  void loadModel(Resource file) throws IOException;

  /**
	 * Load a pre-trained model
   * @param dir The path to create the file
   * @param name The name of the model. File extension will be added automatically.
	 */
  void saveModel(Resource dir, String name) throws IOException;

}