ucot.core
Interface ControlInterface

All Known Implementing Classes:
Core

public interface ControlInterface

This interface controls the basics of the UCOT-program (starting, parsing, shuting down etc).


Method Summary
 void addToAnalyzeModel(UseCase usecase)
          Requests core to parse use case, perform heuristic on it and add it to given analyze model
 void addToAnalyzeModel(UseCase usecase, ParserInterface parser)
          Requests core to parse use case, perform heuristic on it and add it to given analyze model
 void addToAnalyzeModel(UseCase usecase, ParserInterface parser, HeuristicInterface heuristic)
          Requests core to parse use case, perform heuristic on it and add it to given analyze model
 void clearAnalyzeModel()
          Clears the whole analyze model.
 AnalyzeModel getAnalyzeModel()
          returns vector of all analyze models from CORE
 HeuristicInterface getCurrentHeuristic()
          returns the current heuristic
 ParserInterface getCurrentParser()
          returns the current default parser
 java.util.Vector<HeuristicInterface> getHeuristics()
          Returns a list of heuristics that are available
 InputCollection getInputs()
          Returns a list of input adapters available.
 java.util.Vector<OutputInterface> getOutputs()
          Returns a list of output adapters available.
 java.util.Vector<ParserInterface> getParsers()
          Returns a vector of parsers that are available
 UseCaseCollection getUseCaseCollection()
          Returns all loaded usecases
 void loadAnalyzeModel(java.net.URL url)
          Loads analyze model from a file
 void loadUseCases(java.net.URL url)
          Loads usecases from file
 void output(java.net.URL url, OutputInterface output, AnalyzeModel model)
          Exports given analyze model to given url using given outputadapter
 void saveAnalyzeModel(java.net.URL url)
          Saves analyze model to a file
 void setCurrentHeuristic(HeuristicInterface heuristic)
          Sets the default heuristic to use.
 void setCurrentParser(ParserInterface parser)
          Sets the default parser to use.
 void shutdown()
          Shuts down the program.
 

Method Detail

shutdown

void shutdown()
Shuts down the program.


clearAnalyzeModel

void clearAnalyzeModel()
Clears the whole analyze model.


loadUseCases

void loadUseCases(java.net.URL url)
Loads usecases from file

Parameters:
url - url of the file

loadAnalyzeModel

void loadAnalyzeModel(java.net.URL url)
Loads analyze model from a file

Parameters:
url - url of the file containing analyze model

saveAnalyzeModel

void saveAnalyzeModel(java.net.URL url)
Saves analyze model to a file

Parameters:
url - target file

getUseCaseCollection

UseCaseCollection getUseCaseCollection()
Returns all loaded usecases

Returns:
use case colletion

addToAnalyzeModel

void addToAnalyzeModel(UseCase usecase)
                       throws java.lang.Exception
Requests core to parse use case, perform heuristic on it and add it to given analyze model

Parameters:
useCase - use case to work magic on
model - analyze model where specified usecase is added
Throws:
java.lang.Exception

addToAnalyzeModel

void addToAnalyzeModel(UseCase usecase,
                       ParserInterface parser)
                       throws java.lang.Exception
Requests core to parse use case, perform heuristic on it and add it to given analyze model

Parameters:
useCase - use case to work magic on
model - analyze model where specified usecase is added
parser - Parser to use
Throws:
java.lang.Exception

addToAnalyzeModel

void addToAnalyzeModel(UseCase usecase,
                       ParserInterface parser,
                       HeuristicInterface heuristic)
                       throws java.lang.Exception
Requests core to parse use case, perform heuristic on it and add it to given analyze model

Parameters:
useCase - use case to work magic on
model - analyze model where specified usecase is added
parser - Parser to use
heuristic - heuristic to use
Throws:
java.lang.Exception

getAnalyzeModel

AnalyzeModel getAnalyzeModel()
returns vector of all analyze models from CORE

Returns:
specified analyze model

getParsers

java.util.Vector<ParserInterface> getParsers()
Returns a vector of parsers that are available

Returns:
vector containing parser adapters

getHeuristics

java.util.Vector<HeuristicInterface> getHeuristics()
Returns a list of heuristics that are available

Returns:
vector containing heuristic adapter

getOutputs

java.util.Vector<OutputInterface> getOutputs()
Returns a list of output adapters available.

Returns:
vector containing output adapter names

getInputs

InputCollection getInputs()
Returns a list of input adapters available.

Returns:
vector containing input adapter names

setCurrentParser

void setCurrentParser(ParserInterface parser)
Sets the default parser to use.

Parameters:
parser - Parser to be used by default

setCurrentHeuristic

void setCurrentHeuristic(HeuristicInterface heuristic)
Sets the default heuristic to use.

Parameters:
heuristic - default heuristic to be used

getCurrentParser

ParserInterface getCurrentParser()
returns the current default parser

Returns:
default parser

getCurrentHeuristic

HeuristicInterface getCurrentHeuristic()
returns the current heuristic

Returns:
current heuristic

output

void output(java.net.URL url,
            OutputInterface output,
            AnalyzeModel model)
            throws java.lang.Exception
Exports given analyze model to given url using given outputadapter

Parameters:
url - destination url
output - output adapter
model - analyzemodel to export
Throws:
java.lang.Exception