nz.ac.waikato.mcennis.rat
Interface Component

All Superinterfaces:

Model

All Known Subinterfaces:

Algorithm, DataAquisition

All Known Implementing Classes:

ActorDistanceMatrix, AggregateActorToGraph, AggregateByLinkProperty, AggregateGraphToGraph, AggregateLinks, AggregateLinkToGraph, AggregateOnActor, AggregateOnGraph, AssociativeMining, BasicDisplayGraph, Betweeness, BicomponentClusterer, BuildClassifierPerActor, BuildClassifierSingleAttribute, ClassifyPerActor, ClassifySingleAttribute, Closeness, ColoredByPropertyGraph, CombineProperty, CrawlLastFM, CrawlLiveJournal, CrossValidationByActor, CrossValidationByGraph, CrossValidationByLinks, DegreeGraphProperties, DegreePrestige, Difference, DirectedTriplesHistogram, DisplayAll, EnumerateMaximalCliques, FileReader, FileReader2Pass, FindStronglyConnectedComponents, FindWeaklyConnectedComponents, FromGraphToActor, GeodesicPaths, GeodesicProperties, GetArtistTags, GraphSimilarityByProperty, HalfLife, HierarchyByCooccurance, HITSPrestige, IdentifyBridges, Item2Item, KendallTau, LastFMTagFileReader, LinkBetweeness, LoadBibliographyAndClass, LoadBibliographyXML, MeanErrorEvaluation, NormanGirvanEdgeBetweenessClustering, OptimizedPathBase, OutputBibliographyXML, OutputBridgesByCluster, OutputDifference, PageRankPrestige, PearsonCorrelation, PrecisionRecallFMeasure, PrincipalComponentsAnalysis, PropertyToLink, RankingProperties, ReadAudioFiles, ReadLastFMProfileFile, ReadMemGraphXMLFile, ROCAreaEvaluation, ScalableHitsPrestige, ScalablePageRankPrestige, SimilarityByLink, SimilarityByProperty, TraditionalEdgeBetweenessClustering, TrimEdgeUsers, UndirectedTriplesHistogram, User2User, WekaClassifierClusterer, 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

java.util.List<IODescriptor>	getInputType() The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
java.util.List<IODescriptor>	getOutputType() The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
Properties	getParameter() List of all parameters this component accepts.
Parameter	getParameter(java.lang.String param) Returns the specific parameter identified by its key-name.
void	init(Properties map) Initialize the object by setting parameters using the given properties map
Component	prototype() All Components implement the prototype pattern.

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

addListener

Method Detail

getInputType

java.util.List<IODescriptor> 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:

IODescriptor array for this component

See Also:

IODescriptor

getOutputType

java.util.List<IODescriptor> 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:

IODescriptor array for this component

See Also:

IODescriptor

getParameter

Properties 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

init

void init(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

prototype

Component prototype()

All Components implement the prototype pattern. The new parameter has no common resources to the original that are not static resources o the class.

Returns:

default-parameter version of the same class as the original.