net.myrrix.online.generation

Class DelegateGenerationManager

java.lang.Object

net.myrrix.online.generation.DelegateGenerationManager

All Implemented Interfaces:

Closeable, AutoCloseable, GenerationManager

public final class DelegateGenerationManager
extends Object
implements GenerationManager

Manages one generation of the underlying recommender model. Input is read from a local file system, written to a local file system, and the intermediate model is stored on a local file system.

Since:

1.0

Author:

Sean Owen

Constructor Summary

Constructors

Constructor and Description
DelegateGenerationManager(File localInputDir)
DelegateGenerationManager(String bucket, String instanceID, File localInputDir, int partition, ReloadingReference<List<?>> allPartitions, File licenseFile)

Method Summary

Methods

Modifier and Type	Method and Description
void	append(long userID, long itemID, float value, boolean bulk) Sends a new user / item association to the component responsible for later recomputing the model based on this, and other, updates.
void	appendItemTag(String tag, long itemID, float value, boolean bulk) Sends a new tag / item association to the component responsible for later recomputing the model based on this, and other, updates.
void	appendUserTag(long userID, String tag, float value, boolean bulk) Sends a new user / tag association to the component responsible for later recomputing the model based on this, and other, updates.
void	bulkDone() Signals the end of a string of updates from a bulk update, like an ingest request.
void	close()
String	getBucket() Not used.
Generation	getCurrentGeneration()
String	getInstanceID() Not used.
void	refresh() Triggers a refresh of the object's internal state, which particularly includes rebuilding or reloading a matrix model.
void	remove(long userID, long itemID, boolean bulk) Records that the user-item association should be removed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateGenerationManager

public DelegateGenerationManager(File localInputDir)
                          throws IOException

Parameters:

localInputDir - local work directory from which input is read, and to which additional input is written. The model file is stored here too. Input in CSV format can be placed in this directory at any time. The file name should end in ".csv" and the file should contain lines of the form "userID,itemID(,value)".

Throws:

IOException

DelegateGenerationManager

public DelegateGenerationManager(String bucket,
                         String instanceID,
                         File localInputDir,
                         int partition,
                         ReloadingReference<List<?>> allPartitions,
                         File licenseFile)
                          throws IOException

Parameters:

bucket - not used in local mode; required for API compatibility internally

instanceID - not used in local mode; required for API compatibility internally

localInputDir - local work directory from which input is read, and to which additional input is written. The model file is stored here too. Input in CSV format can be placed in this directory at any time. The file name should end in ".csv" and the file should contain lines of the form "userID,itemID(,value)".

partition - not used; required for API compatibility internally

allPartitions - not used; required for API compatibility internally

licenseFile - not used; required for API compatibility internally

Throws:

IOException

Method Detail

getBucket

public String getBucket()

Not used.

Specified by:

getBucket in interface GenerationManager

Returns:

null

getInstanceID

public String getInstanceID()

Not used.

Specified by:

getInstanceID in interface GenerationManager

Returns:

null

append

public void append(long userID,
          long itemID,
          float value,
          boolean bulk)
            throws IOException

Description copied from interface: GenerationManager

Sends a new user / item association to the component responsible for later recomputing the model based on this, and other, updates.

Specified by:

append in interface GenerationManager

Parameters:

userID - user involved in new association

itemID - item involved

value - strength of the user/item association

bulk - if true, part of a bulk update and should expect many method calls in a row

Throws:

IOException - if an error occurs while sending the update

appendUserTag

public void appendUserTag(long userID,
                 String tag,
                 float value,
                 boolean bulk)
                   throws IOException

Description copied from interface: GenerationManager

Sends a new user / tag association to the component responsible for later recomputing the model based on this, and other, updates.

Specified by:

appendUserTag in interface GenerationManager

Parameters:

userID - user involved in new association

tag - the tag

value - strength of the user/item association

bulk - if true, part of a bulk update and should expect many method calls in a row

Throws:

IOException - if an error occurs while sending the update

appendItemTag

public void appendItemTag(String tag,
                 long itemID,
                 float value,
                 boolean bulk)
                   throws IOException

Description copied from interface: GenerationManager

Sends a new tag / item association to the component responsible for later recomputing the model based on this, and other, updates.

Specified by:

appendItemTag in interface GenerationManager

Parameters:

tag - the tag

itemID - item involved in new association

value - strength of the tag/item association

bulk - if true, part of a bulk update and should expect many method calls in a row

Throws:

IOException - if an error occurs while sending the update

remove

public void remove(long userID,
          long itemID,
          boolean bulk)
            throws IOException

Description copied from interface: GenerationManager

Records that the user-item association should be removed. This is different from recording a negative association.

Specified by:

remove in interface GenerationManager

Parameters:

userID - user involved in new association

itemID - item involved

bulk - if true, part of a bulk update and should expect many method calls in a row

Throws:

IOException - if an error occurs while sending the update

bulkDone

public void bulkDone()
              throws IOException

Description copied from interface: GenerationManager

Signals the end of a string of updates from a bulk update, like an ingest request.

Specified by:

bulkDone in interface GenerationManager

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

refresh

public void refresh()

Description copied from interface: GenerationManager

Triggers a refresh of the object's internal state, which particularly includes rebuilding or reloading a matrix model.

Specified by:

refresh in interface GenerationManager

getCurrentGeneration

public Generation getCurrentGeneration()

Specified by:

getCurrentGeneration in interface GenerationManager

Returns:

an instance of the latest Generation that has been made available by the implementation.