com.cloudera.oryx.api.speed

Class AbstractSpeedModelManager<K,M,U>

java.lang.Object

com.cloudera.oryx.api.speed.AbstractSpeedModelManager<K,M,U>

Type Parameters:

K - type of key read from input topic

M - type of message read from input topic

U - type of update message read/written

All Implemented Interfaces:

SpeedModelManager<K,M,U>, Closeable, AutoCloseable

Direct Known Subclasses:

ALSSpeedModelManager, ExampleSpeedModelManager, KMeansSpeedModelManager, RDFSpeedModelManager

public abstract class AbstractSpeedModelManager<K,M,U>
extends Object
implements SpeedModelManager<K,M,U>

Convenience implementation of SpeedModelManager that provides default implementations.

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
AbstractSpeedModelManager()

Method Summary

Modifier and Type	Method and Description
void	consume(Iterator<KeyMessage<String,U>> updateIterator, org.apache.hadoop.conf.Configuration hadoopConf) Called by the framework to initiate a continuous process of reading models, and reading from the input topic and updating model state in memory, and issuing updates to the update topic.
void	consumeKeyMessage(String key, U message, org.apache.hadoop.conf.Configuration hadoopConf) Convenience method that is called by the default implementation of consume(Iterator, Configuration), to process one key-message pair.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudera.oryx.api.speed.SpeedModelManager

buildUpdates, close

Constructor Detail

AbstractSpeedModelManager

public AbstractSpeedModelManager()

Method Detail

consume

public void consume(Iterator<KeyMessage<String,U>> updateIterator,
                    org.apache.hadoop.conf.Configuration hadoopConf)
             throws IOException

Description copied from interface: SpeedModelManager

Called by the framework to initiate a continuous process of reading models, and reading from the input topic and updating model state in memory, and issuing updates to the update topic. This will be executed asynchronously and may block. Note that an exception or error thrown from this method is fatal and shuts down processing.

Specified by:

consume in interface SpeedModelManager<K,M,U>

Parameters:

updateIterator - iterator to read models from

hadoopConf - Hadoop context, which may be required for reading from HDFS

Throws:

IOException - if an error occurs while reading updates

consumeKeyMessage

public void consumeKeyMessage(String key,
                              U message,
                              org.apache.hadoop.conf.Configuration hadoopConf)
                       throws IOException

Convenience method that is called by the default implementation of consume(Iterator, Configuration), to process one key-message pair. It does nothing, except log the message. This should generally be overridden if and only if consume(Iterator, Configuration) is not.

Parameters:

key - key to process (non-null)

message - message to process

hadoopConf - Hadoop configuration for process

Throws:

IOException - if an error occurs while processing the message

Since:

2.3.0