public class KDDAnalysisDocument extends java.lang.Object implements IAnalysisDocument
KDDAnalysisDocument is a realization of the IAnalysisDocument interface and is responsible for the construction of user-specified data mining algorithms and corresponding plots. It utilizes the Strategy pattern to decouple itself from the actual construction of individual data mining algorithms.
Constructor and Description |
---|
KDDAnalysisDocument()
The constructor
|
KDDAnalysisDocument(KDDStrategyFactory factory)
The constructor for direct injection of a specialization of the
KDDStrategyFactory.
|
Modifier and Type | Method and Description |
---|---|
void |
createSelectedAssets()
This operation creates the selected assets in the IAnalysisDocument.
|
java.util.ArrayList<IAnalysisAsset> |
getAllAssets()
This operation returns all assets created for all data slices in the IAnalysisDocument.
|
java.util.ArrayList<Entry> |
getAssetPropertiesAsEntryList(java.lang.String assetName)
Return the asset properties of the given available asset name as a list
of Entries.
|
java.util.ArrayList<IAnalysisAsset> |
getAssetsAtSlice(int sliceNumber)
This operation returns the set of assets created for the specified data slice.
|
java.util.ArrayList<java.lang.String> |
getAvailableAssets()
This operation provides a list of all of the assets that can be created for the data under consideration by this IAnalysisDocument.
|
java.net.URI |
getData()
This operation returns a URI specifying the location of the data from which this IAnalysisDocument is creating IAnalysisAssets.
|
java.net.URI |
getReferenceData()
This operation returns a URI specifying the location of the reference data used by this IAnalysisDocument.
|
java.util.ArrayList<java.lang.String> |
getSelectedAssets()
This operation returns the list of all of assets that should be or was created for the data at each slice for this IAnalysisDocument.
|
java.lang.String |
getSliceIdentifier(int sliceNumber)
This operation returns a string that identifies the data slice in way that is more descriptive than just its slice id.
|
int |
getTotalSlices()
This operation returns the total number of data slices that exist in the document.
|
boolean |
loadData(IDataProvider data)
This operation directs the IAnalysisDocument to load or otherwise use data from an IDataProvider.
|
boolean |
loadData(java.net.URI data)
This operation directs the IAnalysisDocument to load or otherwise use data from a folder or file with the specified URI.
|
boolean |
loadReferenceData(IDataProvider data)
This operation directs the IAnalysisDocument to load or otherwise use data from an IDataProvider as a reference for comparison with the data loaded by loadData().
|
boolean |
loadReferenceData(java.net.URI data)
This operation directs the IAnalysisDocument to load or otherwise use data from a folder or file with the specified URI.
|
void |
setSelectedAssets(java.util.ArrayList<java.lang.String> assets)
This operation specifies the list of all of assets that should be created for the data at each slice for this IAnalysisDocument.
|
public KDDAnalysisDocument()
The constructor
public KDDAnalysisDocument(KDDStrategyFactory factory)
The constructor for direct injection of a specialization of the KDDStrategyFactory. Primarily used for testing.
factory
- KDDStrategyFactory directly injected into KDDAnalysisDocument for use in the construction of KDDStrategies.
public java.util.ArrayList<Entry> getAssetPropertiesAsEntryList(java.lang.String assetName)
Return the asset properties of the given available asset name as a list of Entries.
assetName
- public boolean loadData(java.net.URI data)
IAnalysisDocument
This operation directs the IAnalysisDocument to load or otherwise use data from a folder or file with the specified URI. All IAnalysisAssets will be created from this data.
loadData
in interface IAnalysisDocument
data
- A URI to the data folder or file used to create assets for this document.
True if the IAnalysisDocument can create assets from the data, false if not. If this operation returns false, this IAnalysisDocument should not be used.
public boolean loadData(IDataProvider data)
IAnalysisDocument
This operation directs the IAnalysisDocument to load or otherwise use data from an IDataProvider. All IAnalysisAssets will be created from this data.
loadData
in interface IAnalysisDocument
data
- An IDataProvider used to create assets for this document.
True if the IAnalysisDocument can create assets from the data, false if not. If this operation returns false, this IAnalysisDocument should not be used.
public boolean loadReferenceData(java.net.URI data)
IAnalysisDocument
This operation directs the IAnalysisDocument to load or otherwise use data from a folder or file with the specified URI. All IAnalysisAssets will be created from this data.
loadReferenceData
in interface IAnalysisDocument
data
- A URI to the data folder or file used to retrieve the reference data.
True if the IAnalysisDocument can create assets from the data, false if not. If this operation returns false, this IAnalysisDocument should not be used.
public boolean loadReferenceData(IDataProvider data)
IAnalysisDocument
This operation directs the IAnalysisDocument to load or otherwise use data from an IDataProvider as a reference for comparison with the data loaded by loadData().
loadReferenceData
in interface IAnalysisDocument
data
- An IDataProvider used to retrieve the reference data.
True if the IAnalysisDocument can create assets from the data, false if not. If this operation returns false, this IAnalysisDocument should not be used.
public java.net.URI getData()
IAnalysisDocument
This operation returns a URI specifying the location of the data from which this IAnalysisDocument is creating IAnalysisAssets.
getData
in interface IAnalysisDocument
A URI to the data folder or file used to create assets for this document.
public java.util.ArrayList<java.lang.String> getAvailableAssets()
IAnalysisDocument
This operation provides a list of all of the assets that can be created for the data under consideration by this IAnalysisDocument.
getAvailableAssets
in interface IAnalysisDocument
The list of assets that can be created for this IAnalysisDocument or null if the document can not create any assets.
public java.util.ArrayList<java.lang.String> getSelectedAssets()
IAnalysisDocument
This operation returns the list of all of assets that should be or was created for the data at each slice for this IAnalysisDocument.
getSelectedAssets
in interface IAnalysisDocument
The list of assets.
public void setSelectedAssets(java.util.ArrayList<java.lang.String> assets)
IAnalysisDocument
This operation specifies the list of all of assets that should be created for the data at each slice for this IAnalysisDocument. Setting the list of desired assets sets it for all data slices. In general, this operation should be called after getAvailableAssets() unless it is known for certain that the list of desired assets can be created in the document.
setSelectedAssets
in interface IAnalysisDocument
assets
- The lists of assets that should be created for each slice of data in this IAnalysisDocument.
public void createSelectedAssets()
IAnalysisDocument
This operation creates the selected assets in the IAnalysisDocument. This is a potentially long-running operation depending on the data and the analysis operations.
createSelectedAssets
in interface IAnalysisDocument
public int getTotalSlices()
IAnalysisDocument
This operation returns the total number of data slices that exist in the document. This could be, for example, the total number of time steps in the data or the total number of cells. This operation will return 0 if the IAnalysisDocument can not manipulate the data.
getTotalSlices
in interface IAnalysisDocument
The total number of data slices in this IAnalysisDocument.
public java.lang.String getSliceIdentifier(int sliceNumber)
IAnalysisDocument
This operation returns a string that identifies the data slice in way that is more descriptive than just its slice id. This could be, for example, a number identifying the time step or the cell id.
getSliceIdentifier
in interface IAnalysisDocument
The identifier with more information about the slice.
public java.util.ArrayList<IAnalysisAsset> getAssetsAtSlice(int sliceNumber)
IAnalysisDocument
This operation returns the set of assets created for the specified data slice.
getAssetsAtSlice
in interface IAnalysisDocument
sliceNumber
- The slice of data for which assets should be retrieved.
All of the assets for the specified slice of data in the document or null if no assets have been created or otherwise just don't exist.
public java.util.ArrayList<IAnalysisAsset> getAllAssets()
IAnalysisDocument
This operation returns all assets created for all data slices in the IAnalysisDocument.
getAllAssets
in interface IAnalysisDocument
All of the assets for all of the data slices in the document or null if no assets have been created or otherwise just don't exist.
public java.net.URI getReferenceData()
IAnalysisDocument
This operation returns a URI specifying the location of the reference data used by this IAnalysisDocument.
getReferenceData
in interface IAnalysisDocument
A URI to the data folder or file used to create assets for this document.