network

Class NetworkFileBackedWrapper

java.lang.Object

network.NetworkFileBackedWrapper

public class NetworkFileBackedWrapper
extends java.lang.Object

NetworkFileBackedWrapper represents the target of the re-ranking of Netter. It consists of the top of a ranking, originating from a certain file. This top of the ranking is represented as a Network and will be modified. Optionally, the network is cut in pieces and represented by a NetworkPartition with associated weights.

Since:

0.0

Version:

1.0

Author:

Joeri Ruyssinck (joeri.ruysssinck@intec.ugent.be)

Constructor Summary

Constructors

Constructor and Description
NetworkFileBackedWrapper(NetworkFileBackedWrapper copy) Copy constructor of a NetworkFileBackedWrapper.
NetworkFileBackedWrapper(java.lang.String fileName, int cutoff, int chuncks, double coefs, boolean createPartition) Constructs a new NetworkFileBackedWrapper with the given parameters

Method Summary

Modifier and Type	Method and Description
int	getChuncks()
double	getCoefs()
int	getCutoff()
java.lang.String	getFileName()
Network	getNetwork()
java.lang.String	getOutputFileName()
NetworkPartition	getPartition()
void	networkClear() This method should be called when the ranking file is no longer needed.
void	networkToTSVfinal() Writes the current ranking to the outputFileName.
void	setChuncks(int chuncks)
void	setCoefs(double coefs)
void	setCutoff(int cutoff)
void	setFileName(java.lang.String fileName)
void	setNetwork(Network network)
void	setOutputFileName(java.lang.String outputFileName)
void	setPartition(NetworkPartition partition)

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkFileBackedWrapper

public NetworkFileBackedWrapper(java.lang.String fileName,
                                int cutoff,
                                int chuncks,
                                double coefs,
                                boolean createPartition)

Constructs a new NetworkFileBackedWrapper with the given parameters

Parameters:

fileName - ranking file to read from

cutoff - cutoff value to determine how many links at the the top of the ranking should be re-ranked

chuncks - size of the partitions, ignored if createPartition is false

coefs - weights of the partitions, ignored if createPartition is false

createPartition - should the network be partitioned

NetworkFileBackedWrapper

public NetworkFileBackedWrapper(NetworkFileBackedWrapper copy)

Copy constructor of a NetworkFileBackedWrapper. It will copy the network, link to the same fileName, networkPartition as well as all other paramaters.

Parameters:

copy - The ranking file representation to be copied

Method Detail

networkClear

public void networkClear()

This method should be called when the ranking file is no longer needed. It deregisters the network context from the NodeCollection to free memory.

networkToTSVfinal

public void networkToTSVfinal()

Writes the current ranking to the outputFileName.

getCutoff

public int getCutoff()

setCutoff

public void setCutoff(int cutoff)

getChuncks

public int getChuncks()

setChuncks

public void setChuncks(int chuncks)

getPartition

public NetworkPartition getPartition()

setPartition

public void setPartition(NetworkPartition partition)

getOutputFileName

public java.lang.String getOutputFileName()

setOutputFileName

public void setOutputFileName(java.lang.String outputFileName)

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String fileName)

getNetwork

public Network getNetwork()

setNetwork

public void setNetwork(Network network)

getCoefs

public double getCoefs()

setCoefs

public void setCoefs(double coefs)