nz.ac.waikato.mcennis.rat
Interface Component

All Superinterfaces:

Model

All Known Subinterfaces:

Algorithm, DataAquisition

All Known Implementing Classes:

ActorDistanceMatrix, AddBasicBetweenessCentrality, AddBasicGeodesicPaths, AddBasicInterestLink, AddBetweenessCentrality, AddClosenessCentrality, AddCombinedCloseness, AddDegreeCentrality, AddDegreeGraphProperties, AddGeodesicProperties, AddMusicLinks, AddMusicRecommendations, AddMusicReferences, AddPageRankPrestige, AggregateByGraph, AggregateByLinkProperty, AggregateLinks, AggregateOnActor, AssociativeMining, BasicDisplayGraph, BicomponentClusterer, ColoredByPropertyGraph, CombineProperty, CrawlLastFM, CrawlLiveJournal, Difference, DirectedTriplesHistogram, DisplayAll, EnumerateMaximalCliques, ExtractMusicCoverage, FileReader, FileReader2Pass, FindStronglyConnectedComponents, FindWeaklyConnectedComponents, FromGraphToActor, GetArtistTags, GraphSimilarityByProperty, HalfLife, HierarchyByCooccurance, HITSPrestige, IdentifyBridges, Item2Item, KendallTau, LastFMTagFileReader, LoadBibliographyAndClass, LoadBibliographyXML, MeanErrorEvaluation, MultiInstanceSVM, NaiveImplementClique, NormanGirvanEdgeBetweenessClustering, OptimizedBetweeness, OptimizedCloseness, OptimizedLinkBetweeness, OptimizedPathBase, OutputBibliographyXML, OutputBridgesByCluster, OutputDifference, PearsonCorrelation, PrecisionRecallFMeasure, PrincipalComponentsAnalysis, PropertyToLink, RankingProperties, ReadAudioFiles, ReadLastFMProfileFile, ReadMemGraphXMLFile, RecommendationError, ROCAreaEvaluation, ScalableHitsPrestige, ScalablePageRankPrestige, SimilarityByLink, SimilarityByProperty, SVM, TraditionalEdgeBetweenessClustering, TrimEdgeUsers, UndirectedTriplesHistogram, User2User, WekaClassifierClusterer, WekaClassifierMultiAttribute, WekaClassifierOneAttribute, WekaProbablisticClusterer

public interface Component
extends Model

This class describes the self-documenting features of the different components that make up the toolkit. Every component describes what it creates, what it generates, and what kinds of parameters it accepts

Method Summary

InputDescriptor[]	getInputType() The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
OutputDescriptor[]	getOutputType() The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
Parameter[]	getParameter() List of all parameters this component accepts.
Parameter	getParameter(java.lang.String param) Returns the specific parameter identified by its key-name.
SettableParameter[]	getSettableParameter() Returns settable (i.e.
SettableParameter	getSettableParameter(java.lang.String param) Return the settable parameter namede by this key-name.
void	init(java.util.Properties map) Initialize the object by setting parameters using the given properties map

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model

addListener

Method Detail

getInputType

InputDescriptor[] getInputType()

The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Returns:

InputDescriptor array for this component

See Also:

InputDescriptor

getOutputType

OutputDescriptor[] getOutputType()

The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Returns:

OutputDescriptor array for this component

See Also:

OutputDescriptor

getParameter

Parameter[] getParameter()

List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Returns:

read-only array of Parameters

getParameter

Parameter getParameter(java.lang.String param)

Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Parameters:

param - key-name of the parameter

Returns:

named parameter

getSettableParameter

SettableParameter[] getSettableParameter()

Returns settable (i.e. editable while running) parameters. If none exist, null is returned.

Returns:

array of settable parameters

getSettableParameter

SettableParameter getSettableParameter(java.lang.String param)

Return the settable parameter namede by this key-name. If this parameter is not found or is not settable, null is returned.

Parameters:

param - key-name of the parameter

Returns:

named settable parameter

init

void init(java.util.Properties map)

Initialize the object by setting parameters using the given properties map

Parameters:

map - map of the given properties naming parameters and their values in a string