org.ranksys.formats.preference

Class CompressibleRatingPreferencesFormat

java.lang.Object

org.ranksys.formats.preference.CompressibleRatingPreferencesFormat

public class CompressibleRatingPreferencesFormat
extends Object

Compression-ready format for rating preference data.

Author:

Saúl Vargas (Saul@VargasSandoval.es)

Constructor Summary

Constructors

Constructor and Description
CompressibleRatingPreferencesFormat()

Method Summary

Modifier and Type	Method and Description
static CompressibleRatingPreferencesFormat	get() Gets an instance of this class.
Stream<Tuple2io<int[][]>>	read(InputStream in) Reads an input stream that complies with this format.
Stream<Tuple2io<int[][]>>	read(String in) Reads a file that complies with this format.
void	write(FastPreferenceData<?,?> prefData, OutputStream uo, OutputStream io) Saves a PreferenceData instance in two files for user and item preferences, respectively.
void	write(FastPreferenceData<?,?> prefData, String up, String ip) Saves a PreferenceData instance in two files for user and item preferences, respectively.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompressibleRatingPreferencesFormat

public CompressibleRatingPreferencesFormat()

Method Detail

get

public static CompressibleRatingPreferencesFormat get()

Gets an instance of this class.

Returns:

instance of this class

write

public void write(FastPreferenceData<?,?> prefData,
                  String up,
                  String ip)
           throws FileNotFoundException,
                  IOException

Saves a PreferenceData instance in two files for user and item preferences, respectively. The format of the user preferences file consists on one list per line, starting with the identifier of the user followed by the identifier-rating pairs of the items related to that. The item preferences file follows the same format by swapping the roles of users and items.

Parameters:

prefData - preferences

up - path to user preferences file

ip - path to item preferences file

Throws:

FileNotFoundException - one of the files could not be created

IOException - other IO error

write

public void write(FastPreferenceData<?,?> prefData,
                  OutputStream uo,
                  OutputStream io)
           throws IOException

Saves a PreferenceData instance in two files for user and item preferences, respectively. The format of the user preferences stream consists on one list per line, starting with the identifier of the user followed by the identifier-rating pairs of the items related to that. The item preferences stream follows the same format by swapping the roles of users and items.

Parameters:

prefData - preferences

uo - stream of user preferences

io - stream of user preferences

Throws:

IOException - when IO error

read

public Stream<Tuple2io<int[][]>> read(String in)
                               throws FileNotFoundException

Reads a file that complies with this format.

Parameters:

in - path to file

Returns:

stream of user/item to preferences

Throws:

FileNotFoundException - when file does not exist

read

public Stream<Tuple2io<int[][]>> read(InputStream in)

Reads an input stream that complies with this format.

Parameters:

in - input stream

Returns:

stream of user/item to preferences