org.electrocodeogram.cpc.exports.api.exports.adapter
Interface IExportToolAdapterResult


public interface IExportToolAdapterResult

Export result wrapper for the IExportToolAdapter.

An IExportToolAdapter implementation is not required to fill provide all of these statistics.
By default all values are -1.

Author:
vw

Method Summary
 int getExportedCloneCount()
          Retrieves the number of clones exported.
 int getExportedCloneFileCount()
          Retrieves the number of exported files which contained at least one clone.
 int getExportedCloneGroupCount()
          Retrieves the number of clone groups exported.
 int getTotalCloneCount()
          Retrieves the total number of clones found in the given files.
 int getTotalCloneFileCount()
          Retrieves the number of processed files which contained at least one clone.
 int getTotalCloneGroupCount()
          Retrieves the total number of clone groups found in the given files.
 void setExportedCloneCount(int exportedCloneCount)
          Sets the number of clones exported.
 void setExportedCloneFileCount(int exportedCloneFileCount)
          Sets the number of exported files which contained at least one clone.
 void setExportedCloneGroupCount(int exportedCloneGroupCount)
          Sets the number of clone groups exported.
 void setTotalCloneCount(int totalCloneCount)
          Sets the total number of clones found in the given files.
 void setTotalCloneFileCount(int totalCloneFileCount)
          Sets the number of processed files which contained at least one clone.
 void setTotalCloneGroupCount(int totalCloneGroupCount)
          Sets the total number of clone groups found in the given files.
 

Method Detail

getTotalCloneCount

int getTotalCloneCount()
Retrieves the total number of clones found in the given files.

Returns:
total number of clones found in the given files.

setTotalCloneCount

void setTotalCloneCount(int totalCloneCount)
Sets the total number of clones found in the given files.

Parameters:
totalCloneCount - total number of clones found in the given files.

getExportedCloneCount

int getExportedCloneCount()
Retrieves the number of clones exported.

Returns:
number of clones exported.

setExportedCloneCount

void setExportedCloneCount(int exportedCloneCount)
Sets the number of clones exported.

Parameters:
exportedCloneCount - number of clones exported.

getTotalCloneGroupCount

int getTotalCloneGroupCount()
Retrieves the total number of clone groups found in the given files.

Returns:
total number of clone groups found in the given files.

setTotalCloneGroupCount

void setTotalCloneGroupCount(int totalCloneGroupCount)
Sets the total number of clone groups found in the given files.

Parameters:
totalCloneGroupCount - total number of clone groups found in the given files.

getExportedCloneGroupCount

int getExportedCloneGroupCount()
Retrieves the number of clone groups exported.

Returns:
number of clone groups exported.

setExportedCloneGroupCount

void setExportedCloneGroupCount(int exportedCloneGroupCount)
Sets the number of clone groups exported.

Parameters:
exportedCloneGroupCount - number of clone groups exported.

getTotalCloneFileCount

int getTotalCloneFileCount()
Retrieves the number of processed files which contained at least one clone.

Returns:
number of processed files which contained at least one clone.

setTotalCloneFileCount

void setTotalCloneFileCount(int totalCloneFileCount)
Sets the number of processed files which contained at least one clone.

Parameters:
totalCloneFileCount - number of processed files which contained at least one clone.

getExportedCloneFileCount

int getExportedCloneFileCount()
Retrieves the number of exported files which contained at least one clone.

Returns:
number of exported files which contained at least one clone.

setExportedCloneFileCount

void setExportedCloneFileCount(int exportedCloneFileCount)
Sets the number of exported files which contained at least one clone.

Parameters:
exportedCloneFileCount - number of exported files which contained at least one clone.