Package adams.flow.core

Interface ModelLoaderSupporter

All Superinterfaces:

ModelFileHandler

All Known Subinterfaces:

DynamicModelLoaderSupporter

All Known Implementing Classes:

AbstractModelLoader, AbstractProcessWekaInstanceWithModel, WekaClassifierModelLoader, WekaClassifying, WekaClustererModelLoader, WekaClustering, WekaFilter, WekaFilterModelLoader

public interface ModelLoaderSupporter
extends ModelFileHandler

Interface for classes that support model loading.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

AbstractModelLoader

Method Summary

Modifier and Type	Method	Description
CallableActorReference	getModelActor()	Returns the callable actor to obtain the model from.
PlaceholderFile	getModelFile()	Returns the file to load the model from.
AbstractModelLoader.ModelLoadingType	getModelLoadingType()	Returns the loading type.
StorageName	getModelStorage()	Returns the storage item name to get the model from.
String	modelActorTipText()	Returns the tip text for this property.
String	modelFileTipText()	Returns the tip text for this property.
String	modelLoadingTypeTipText()	Returns the tip text for this property.
String	modelStorageTipText()	Returns the tip text for this property.
void	setModelActor(CallableActorReference value)	Sets the callable actor to obtain the model from.
void	setModelFile(PlaceholderFile value)	Sets the file to load the model from.
void	setModelLoadingType(AbstractModelLoader.ModelLoadingType value)	Sets the loading type.
void	setModelStorage(StorageName value)	Sets the storage item name to get the model from.

Method Detail

setModelLoadingType

void setModelLoadingType(AbstractModelLoader.ModelLoadingType value)

Sets the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.

Parameters:

value - the type

getModelLoadingType

AbstractModelLoader.ModelLoadingType getModelLoadingType()

Returns the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.

Returns:

the type

modelLoadingTypeTipText

String modelLoadingTypeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setModelFile

void setModelFile(PlaceholderFile value)

Sets the file to load the model from.

Specified by:

setModelFile in interface ModelFileHandler

Parameters:

value - the model file

getModelFile

PlaceholderFile getModelFile()

Returns the file to load the model from.

Specified by:

getModelFile in interface ModelFileHandler

Returns:

the model file

modelFileTipText

String modelFileTipText()

Returns the tip text for this property.

Specified by:

modelFileTipText in interface ModelFileHandler

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setModelActor

void setModelActor(CallableActorReference value)

Sets the callable actor to obtain the model from.

Parameters:

value - the actor reference

getModelActor

CallableActorReference getModelActor()

Returns the callable actor to obtain the model from.

Returns:

the actor reference

modelActorTipText

String modelActorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setModelStorage

void setModelStorage(StorageName value)

Sets the storage item name to get the model from.

Parameters:

value - the storage name

getModelStorage

StorageName getModelStorage()

Returns the storage item name to get the model from.

Returns:

the storage name

modelStorageTipText

String modelStorageTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.