oracle.spatial.hadoop.vector.mapreduce.job

Class KMeansClustering<K,V>

java.lang.Object

org.apache.hadoop.conf.Configured

oracle.spatial.hadoop.vector.mapred.job.BaseJob<K,V>

oracle.spatial.hadoop.vector.mapred.job.KMeansClustering<K,V>

oracle.spatial.hadoop.vector.mapreduce.job.KMeansClustering<K,V>

Type Parameters:

K - the type of the input keys

V - the type of the input values

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

public class KMeansClustering<K,V>
extends KMeansClustering<K,V>

Class used to perform spatial clustering over an input data set.The clustering is performed running one or more jobs iteratively.

Field Summary

Fields inherited from class oracle.spatial.hadoop.vector.mapred.job.KMeansClustering

ARG_CLUSTERS_POINTS, ARG_CRIT_FUN_CLASS, ARG_DELETE_CLUSTER_FILES, ARG_K, ARG_MAX_ITERATIONS, ARG_MAX_MEMBER_DISTANCE, ARG_SHAPE_GEN_CLASS, clustersPoints, critetionFunctionClass, deletePreviousClusterFiles, dimensions, inClustersPath, initKPointsPassed, iteration, k, maxIterations, maxMemberDistance, shapeGeneratorClass, workDirPath

Fields inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob

argsp, inputDataSet, jarClass, jobRegEntryPath, proxyIDS

Constructor Summary

Constructors

Constructor and Description
KMeansClustering()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.hadoop.mapreduce.Job job) Validates and adds the current parameters to the job configuration
protected InputDataSetConfiguratorHandler	getInputDataSetConfiguratorHandler(org.apache.hadoop.conf.Configuration conf) Returns the current instance of InputDataSetConfiguratorHandler used to configure the input data set
protected PointWritable[]	getSampledPoints(org.apache.hadoop.conf.Configuration conf)
static <K,V> void	main(java.lang.String[] args)
int	run(java.lang.String[] args)
KMeans.KMeansIterationResult	runIteration(int iteration, org.apache.hadoop.conf.Configuration baseConf) Launches a mapreduce job to run a single iteration
boolean	runIterations(int maxIterations, org.apache.hadoop.conf.Configuration baseConf) Runs the K Means clustering algorithm using the given configuration

Methods inherited from class oracle.spatial.hadoop.vector.mapred.job.KMeansClustering

configure, deletePreviousClustersFiles, generateFinalResultClustersFile, generateInitialKClustersPoints, getClustersPoints, getCmdOptions, getCritetionFunctionClass, getCurrentCmdArgs, getInClustersPath, getInputDataSetCmdParserHandler, getIteration, getK, getMaxIterations, getShapeGeneratorClass, getWorkDirPath, isDeletePreviousClusterFiles, isNextIteration, pointsToClusterInfo, processArgs, replaceEmptyOutClusters, runIteration, runIterations, setClustersPoints, setCritetionFunctionClass, setDeletePreviousClusterFiles, setInClustersPath, setIteration, setK, setMaxIterations, setOutput, setShapeGeneratorClass, setupNextIteractionClusters

Methods inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob

addJobRegistryEntry, addJobRegistryEntry, addJobRegistryEntry, createJob, createJob, createJob, createJob, createJobConf, createJobConf, createJobConf, getCmdOptionsWithInputDataSets, getCmdOptionsWithInputDataSets, getCurrentCmdArgsAsString, getCurrentCmdArgsAsString, getInput, getInputDataSet, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, runJob, runJob, setInput, setInputDataSet, setInputFormatClass, setJarClass, setRecordInfoProviderClass, setSpatialConfig, updateInputDataSet

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf, setConf

Constructor Detail

KMeansClustering

public KMeansClustering()

Method Detail

getInputDataSetConfiguratorHandler

protected InputDataSetConfiguratorHandler getInputDataSetConfiguratorHandler(org.apache.hadoop.conf.Configuration conf)

Description copied from class: BaseJob

Returns the current instance of InputDataSetConfiguratorHandler used to configure the input data set

Overrides:

getInputDataSetConfiguratorHandler in class KMeansClustering<K,V>

Parameters:

conf - a job configuration

Returns:

an instance of InputDataSetConfiguratorHandler

configure

public void configure(org.apache.hadoop.mapreduce.Job job)
               throws java.lang.Exception

Description copied from class: BaseJob

Validates and adds the current parameters to the job configuration

Overrides:

configure in class BaseJob<K,V>

Parameters:

job - a job instance

Throws:

java.lang.Exception

runIteration

public KMeans.KMeansIterationResult runIteration(int iteration,
                                        org.apache.hadoop.conf.Configuration baseConf)
                                          throws java.lang.Exception

Launches a mapreduce job to run a single iteration

Parameters:

iteration - the iteration number

baseConf - the job configuration

Returns:

a KMeans.KMeansIterationResult containing the results of the iteration

Throws:

java.lang.Exception

getSampledPoints

protected PointWritable[] getSampledPoints(org.apache.hadoop.conf.Configuration conf)
                                    throws java.io.IOException,
                                           java.lang.InterruptedException

Overrides:

getSampledPoints in class KMeansClustering<K,V>

Throws:

java.io.IOException

java.lang.InterruptedException

runIterations

public boolean runIterations(int maxIterations,
                    org.apache.hadoop.conf.Configuration baseConf)
                      throws java.lang.Exception

Runs the K Means clustering algorithm using the given configuration

Parameters:

maxIterations - the maximum number of iterations. If zero is passed, a default value based on the number of clusters will be used

baseConf - the job configuration

Returns:

true if the algortihm was successful

Throws:

java.lang.Exception

run

public int run(java.lang.String[] args)
        throws java.lang.Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Overrides:

run in class KMeansClustering<K,V>

Throws:

java.lang.Exception

main

public static <K,V> void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception