Interface IO
- All Known Subinterfaces:
ProCAKEReader
,ProCAKEWriter
- All Known Implementing Classes:
AbstractXMLHandler
,AbstractXMLReader
,AbstractXMLWriter
,AdaptationConfigHandler
,AdaptationConfigReader
,DependencyHandler
,DependencyReader
,DependencyWriter
,IOImpl
,ModelHandler
,ModelReader
,ModelWriter
,NESTAbstractWorkflowHandler
,NESTGraphHandler
,NESTGraphReader
,NESTGraphWriter
,NESTSequentialWorkflowHandler
,NESTSequentialWorkflowReader
,NESTSequentialWorkflowWriter
,NESTWorkflowHandler
,NESTWorkflowReader
,NESTWorkflowWriter
,ObjectHandler
,ObjectPoolHandler
,ObjectPoolReader
,ObjectPoolWriter
,ObjectReader
,ObjectWriter
,PrologGraphReader
,SimilarityModelHandler
,SimilarityModelReader
,SimilarityModelWriter
,TrainingObjectPoolHandler
,TrainingObjectPoolReader
,TrainingPoolWriter
,TransformationConfigHandler
,TransformationConfigReaderImpl
,WorkflowGraphMLYWriter
,WorkflowHandler
,WorkflowWriter
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
overwritten copy-method from Object; use it to copy a complete operatorReturns the IO-family of this operatorgetName()
Each io component must have a name that is used inIOFactory.newIO(String)
.boolean
isHandlerFor
(Class value) Checks if the io component is capable to perform the operation for objects of this class.void
Sets the IO-family of this operator
-
Field Details
-
DEFAULT_ENCODING
-
LOG_IO_EXCEPTION
- See Also:
-
LOG_SAX_EXCEPTION
- See Also:
-
LOG_UNKNOWN_PARAMETER
- See Also:
-
LOG_WRONG_PARAMATER_TYPE
- See Also:
-
LOG_READER_NOT_FOUND
- See Also:
-
LOG_FILE_NOT_FOUND
- See Also:
-
RESOURCE_XML
The location where all xml related files are stored, e.g. all grammars like XML Schema or DTD. The value is "/de/uni_trier/wi2/procake/schema/" .- See Also:
-
-
Method Details
-
getName
String getName()Each io component must have a name that is used inIOFactory.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
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
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:
-