Interface IO

All Known Subinterfaces:
ContentHandler, DependencyParser, Reader, Writer
All Known Implementing Classes:
AdaptationConfigHandler, AdaptationConfigParser, DependencyHandler, DependencyParserImpl, DependencyWriterImpl, Deserializer, IOImpl, ModelHandler, ModelParserImpl, ModelWriterImpl, NESTAbstractWorkflowHandler, NESTGraphHandler, NESTGraphParser, NESTGraphWriterImpl, NESTSequentialWorkflowHandler, NESTSequentialWorkflowParser, NESTSequentialWorkflowWriterImpl, NESTWorkflowHandler, NESTWorkflowParser, NESTWorkflowWriterImpl, ObjectHandler, ObjectParser, ObjectPoolHandler, ObjectPoolParser, ObjectPoolWriterImpl, ObjectWriterImpl, PrologGraphParser, Serializer, SimilarityModelHandler, SimilarityModelParserImpl, SimilarityModelWriterImpl, StringReader, StringWriter, TrainingObjectPoolParser, TrainingPoolHandler, TrainingPoolWriter, TransformationConfigHandler, TransformationConfigReaderImpl, WorkflowGraphMLYWriterImpl, WorkflowHandler, WorkflowWriterImpl, XMLReaderImpl, XMLReadHandlerImpl, XMLWriterImpl

public interface IO
The IO interace summarises constants and methods for all io components.

All io components can be created using the IOFactory.newIO(String). The name of the io component must be either known or requested with one of the methods IOFactory.getContentHandlerNamesFor(Class), IOFactory.getReaderNamesFor(Class), or IOFactory.getWriterNamesFor(Class).

Author:
Rainer Maximini
See Also:
  • Field Details

  • Method Details

    • getDescription

      String getDescription()
      A description of the io component. The description should contain the file format and the classes that can be managed.
      Returns:
      a description of the io component
    • getName

      String getName()
      Each io component must have a name that is used in IOFactory.newIO(String). The name must be unique thus it is usefull to use a short description or to the class name ( this.getClass().getName()).
      Returns:
      Returns the name of the io component.
    • isHandlerFor

      boolean isHandlerFor(Class value)
      Checks if the io component is capable to perform the operation for objects of this class.

      A typical implementation looks like:

       public boolean isHandlerFor(Class value) {
              if (DataObject.class.isAssignableFrom(value))
                      return true;
              return false;
       }
       
      Parameters:
      value - The class that has to be checked.
      Returns:
      Results true if the class can oeprate with the given class.
    • getFamily

      String getFamily()
      Returns the IO-family of this operator
      Returns:
    • setFamily

      void setFamily(String familyName)
      Sets the IO-family of this operator
      Parameters:
      familyName -
    • copy

      IO copy()
      overwritten copy-method from Object; use it to copy a complete operator
      Returns: