ucot.input
Interface InputInterface

All Superinterfaces:
ModulePropertyInterface
All Known Implementing Classes:
DummyInput, ProcessMLInputAdapter, SimpleInputAdapter

public interface InputInterface
extends ModulePropertyInterface

Interface for inputs used by UCOT core. Inputs are the modules that handle reading data from given url and parsing usecases from it. User should first check that some URL is readable by this reader by invoking canRead(URL) method. It is up to the Input to set each loaded usecase's url correctly.


Method Summary
 boolean canRead(java.net.URL url)
          Test if this input can read the data in specified url.
 UseCaseCollection read(java.net.URL url)
          Reads usecase collection from URL.
 java.lang.String toString()
          Returns inputs name as a String
 
Methods inherited from interface ucot.ModulePropertyInterface
applyProperties, getProperties, loadDefaultProperties, loadProperties, saveProperties, setProperties
 

Method Detail

read

UseCaseCollection read(java.net.URL url)
                       throws java.lang.Exception

Reads usecase collection from URL.

Parameters:
url - URL where input is loaded from
Returns:
Steps read from the input
Throws:
java.lang.Exception

canRead

boolean canRead(java.net.URL url)

Test if this input can read the data in specified url.

Parameters:
url - The url.
Returns:
true If input can read the contents of the url.

toString

java.lang.String toString()

Returns inputs name as a String

Overrides:
toString in class java.lang.Object
Returns:
name of this input