com.datumbox.framework.core.machinelearning.common.dataobjects

Class TrainableBundle

java.lang.Object

com.datumbox.framework.core.machinelearning.common.dataobjects.TrainableBundle

All Implemented Interfaces:

Savable, java.lang.AutoCloseable

public class TrainableBundle
extends java.lang.Object
implements Savable

This object stores a bundle of Trainables and it is used by algorithms that have other Trainables internally.

Constructor Summary

Constructors

Constructor and Description
TrainableBundle(java.lang.String storageNameSeparator) Public constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	containsKey(java.lang.String key) Returns whether the bundle contains the specified key.
void	delete() Deletes the data of the object.
Trainable	get(java.lang.String key) Returns the trainable with the specific key or null if the key is missing.
java.util.Set<java.lang.String>	keySet() Returns a set with all the keys.
Trainable	put(java.lang.String key, Trainable value) Puts the trainable in the bundle using a specific key and returns the previous entry or null.
void	save(java.lang.String storageName) Saves the data of the object.
void	setParallelized(boolean parallelized) Updates the parallelized flag of all wrapped algorithms.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrainableBundle

public TrainableBundle(java.lang.String storageNameSeparator)

Public constructor.

Parameters:

storageNameSeparator -

Method Detail

keySet

public java.util.Set<java.lang.String> keySet()

Returns a set with all the keys.

Returns:

containsKey

public boolean containsKey(java.lang.String key)

Returns whether the bundle contains the specified key.

Parameters:

key -

Returns:

get

public Trainable get(java.lang.String key)

Returns the trainable with the specific key or null if the key is missing.

Parameters:

key -

Returns:

put

public Trainable put(java.lang.String key,
                     Trainable value)

Puts the trainable in the bundle using a specific key and returns the previous entry or null.

Parameters:

key -

value -

Returns:

setParallelized

public void setParallelized(boolean parallelized)

Updates the parallelized flag of all wrapped algorithms.

Parameters:

parallelized -

save

public void save(java.lang.String storageName)

Saves the data of the object.

Specified by:

save in interface Savable

delete

public void delete()

Deletes the data of the object.

Specified by:

delete in interface Savable

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable