KMeansClustering (Oracle Big Data Spatial and Graph Vector Analysis Java API Reference)

java.lang.Object
- Configured
- - oracle.spatial.hadoop.vector.mapred.job.BaseJob<K,V>
  - - oracle.spatial.hadoop.vector.mapred.job.KMeansClustering<K,V>

Type Parameters:

K - the type of the input keys

V - the type of the input values

Direct Known Subclasses:

KMeansClustering
```
public class KMeansClustering<K,V>
extends BaseJob<K,V>
```
Class used to perform spatial clustering over an input data set.The clustering is performed running one or more jobs iteratively.

Author:

hsaucedo

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARG_CLUSTERS_POINTS`
`static java.lang.String`	`ARG_CRIT_FUN_CLASS`
`static java.lang.String`	`ARG_DELETE_CLUSTER_FILES`
`static java.lang.String`	`ARG_K`
`static java.lang.String`	`ARG_MAX_ITERATIONS`
`static java.lang.String`	`ARG_MAX_MEMBER_DISTANCE`
`static java.lang.String`	`ARG_SHAPE_GEN_CLASS`

Constructor Summary

Constructors
Constructor and Description

KMeansClustering()

Constructors
Constructor and Description
`KMeansClustering()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`configure(JobConf conf)` Validates and adds the current parameters to the job configuration
`double[]`	`getClustersPoints()` Gets the initial clusters points
`java.lang.String`	`getCmdOptions()` Gets a description of the arguments expected from command line.
`java.lang.Class<? extends CriterionFunction>`	`getCritetionFunctionClass()` Gets the `CriterionFunction` subclass to be used
`java.util.Map<java.lang.String,java.lang.Object>`	`getCurrentCmdArgs(Configuration conf)` Returns the current driver properties in a map where each key-value is a name and value of a command line argument.
`Path`	`getInClustersPath()` Gets the path where the input cluster information is located
`int`	`getIteration()` Gets the current iteration number
`int`	`getK()` Gets the number of clusters
`int`	`getMaxIterations()` Gets the maximum number of iterations allowed
`java.lang.Class<? extends ClusterShapeGenerator>`	`getShapeGeneratorClass()` Gets the `ClusterShapeGenerator` subclass to be used
`Path`	`getWorkDirPath()` Gets the path where the mapreduce output is stored at each iteration
`boolean`	`isDeletePreviousClusterFiles()` Specifies whether the output generated by previous iterations should be removed or not
`static <K,V> void`	`main(java.lang.String[] args)`
`void`	`processArgs(java.lang.String[] args, Configuration conf)` Extracts and validates arguments from the command line
`int`	`run(java.lang.String[] args)`
`KMeans.KMeansIterationResult`	`runIteration(int iteration, JobConf baseConf)` Launches a mapreduce job to run a single iteration
`boolean`	`runIterations(int maxIterations, JobConf baseConf)` Runs the K Means clustering algorithm using the given configuration
`void`	`setClustersPoints(double[] clustersPoints)` Sets the initial clusters points
`void`	`setCritetionFunctionClass(java.lang.Class<? extends CriterionFunction> critetionFunctionClass)` Sets the `CriterionFunction` subclass to be used
`void`	`setDeletePreviousClusterFiles(boolean deletePreviousClusterFiles)` Specifies whether the output generated by previous iterations should be removed or not
`void`	`setInClustersPath(Path inClustersPath)` Sets the path where the input cluster information is located
`void`	`setIteration(int iteration)` Sets the current iteration number
`void`	`setK(int k)` Sets the number of clusters
`void`	`setMaxIterations(int maxIterations)` Sets the maximum number of iterations allowed
`void`	`setOutput(java.lang.String output)` Sets the job output
`void`	`setShapeGeneratorClass(java.lang.Class<? extends ClusterShapeGenerator> shapeGeneratorClass)` Sets the `ClusterShapeGenerator` subclass to be used

Methods inherited from class oracle.spatial.hadoop.vector.mapred.job.BaseJob
getCmdOptionsWithInputDataSets, getCurrentCmdArgsAsString, getInput, getInputDataSet, getInputFormatClass, getJarClass, getOutput, getRecordInfoProviderClass, getSpatialConfig, setInput, setInputDataSet, setInputFormatClass, setJarClass, setRecordInfoProviderClass, setSpatialConfig

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ARG_CLUSTERS_POINTS
```
public static final java.lang.String ARG_CLUSTERS_POINTS
```
    See Also:
    
    Constant Field Values
  - ARG_CRIT_FUN_CLASS
```
public static final java.lang.String ARG_CRIT_FUN_CLASS
```
    See Also:
    
    Constant Field Values
  - ARG_DELETE_CLUSTER_FILES
```
public static final java.lang.String ARG_DELETE_CLUSTER_FILES
```
    See Also:
    
    Constant Field Values
  - ARG_K
```
public static final java.lang.String ARG_K
```
    See Also:
    
    Constant Field Values
  - ARG_MAX_ITERATIONS
```
public static final java.lang.String ARG_MAX_ITERATIONS
```
    See Also:
    
    Constant Field Values
  - ARG_MAX_MEMBER_DISTANCE
```
public static final java.lang.String ARG_MAX_MEMBER_DISTANCE
```
    See Also:
    
    Constant Field Values
  - ARG_SHAPE_GEN_CLASS
```
public static final java.lang.String ARG_SHAPE_GEN_CLASS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KMeansClustering
```
public KMeansClustering()
```
- Method Detail
  - configure
```
public void configure(JobConf conf)
               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:
    
    conf - a job instance
    
    Throws:
    
    java.lang.Exception
  - getClustersPoints
```
public double[] getClustersPoints()
```
    Gets the initial clusters points
    
    Returns:
    
    an array of point ordinates in the form x1,y1,x2,y2,...,xK,yK
  - getCmdOptions
```
public java.lang.String getCmdOptions()
```
    Description copied from class: BaseJob
    
    Gets a description of the arguments expected from command line.
    
    Overrides:
    
    getCmdOptions in class BaseJob<K,V>
    
    Returns:
    
    a text description
  - getCritetionFunctionClass
```
public java.lang.Class<? extends CriterionFunction> getCritetionFunctionClass()
```
    Gets the CriterionFunction subclass to be used
    
    Returns:
    
    a CriterionFunction subclass
  - getCurrentCmdArgs
```
public java.util.Map<java.lang.String,java.lang.Object> getCurrentCmdArgs(Configuration conf)
```
    Description copied from class: BaseJob
    
    Returns the current driver properties in a map where each key-value is a name and value of a command line argument. By printing this information it is possible to know how to execute a similar job from command line
    
    Overrides:
    
    getCurrentCmdArgs in class BaseJob<K,V>
    
    Parameters:
    
    conf - a job configuration
    
    Returns:
    
    a map which entries are of type <String,String> or <String, Map<String, Object>> for multiple input data sets. For nested maps, the entry types are the same than the enclosing map
  - getInClustersPath
```
public Path getInClustersPath()
```
    Gets the path where the input cluster information is located
    
    Returns:
    
    a path
  - getIteration
```
public int getIteration()
```
    Gets the current iteration number
    
    Returns:
    
    the current iteration number
  - getK
```
public int getK()
```
    Gets the number of clusters
    
    Returns:
    
    the number of clusters
  - getMaxIterations
```
public int getMaxIterations()
```
    Gets the maximum number of iterations allowed
    
    Returns:
    
    the maximum number of iterations allowed
  - getShapeGeneratorClass
```
public java.lang.Class<? extends ClusterShapeGenerator> getShapeGeneratorClass()
```
    Gets the ClusterShapeGenerator subclass to be used
    
    Returns:
    
    a ClusterShapeGenerator subclass
  - getWorkDirPath
```
public Path getWorkDirPath()
```
    Gets the path where the mapreduce output is stored at each iteration
    
    Returns:
    
    an HDFS path
  - isDeletePreviousClusterFiles
```
public boolean isDeletePreviousClusterFiles()
```
    Specifies whether the output generated by previous iterations should be removed or not
    
    Returns:
    
    true if intermediate output should be removed
  - main
```
public static <K,V> void main(java.lang.String[] args)
                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - processArgs
```
public void processArgs(java.lang.String[] args,
                        Configuration conf)
                 throws java.lang.Exception
```
    Description copied from class: BaseJob
    
    Extracts and validates arguments from the command line
    
    Overrides:
    
    processArgs in class BaseJob<K,V>
    
    Parameters:
    
    args - arguments from the command line
    
    conf - the job configuration
    
    Throws:
    
    java.lang.Exception
  - run
```
public int run(java.lang.String[] args)
        throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - runIteration
```
public KMeans.KMeansIterationResult runIteration(int iteration,
                                                 JobConf 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
  - runIterations
```
public boolean runIterations(int maxIterations,
                             JobConf 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
  - setClustersPoints
```
public void setClustersPoints(double[] clustersPoints)
```
    Sets the initial clusters points
    
    Parameters:
    
    clustersPoints - an array of point ordinates in the form x1,y1,x2,y2,...,xK,yK
  - setCritetionFunctionClass
```
public void setCritetionFunctionClass(java.lang.Class<? extends CriterionFunction> critetionFunctionClass)
```
    Sets the CriterionFunction subclass to be used
    
    Parameters:
    
    critetionFunctionClass - a CriterionFunction subclass
  - setDeletePreviousClusterFiles
```
public void setDeletePreviousClusterFiles(boolean deletePreviousClusterFiles)
```
    Specifies whether the output generated by previous iterations should be removed or not
    
    Parameters:
    
    deletePreviousClusterFiles - true if intermediate output should be removed
  - setInClustersPath
```
public void setInClustersPath(Path inClustersPath)
```
    Sets the path where the input cluster information is located
    
    Parameters:
    
    inClustersPath - a path
  - setIteration
```
public void setIteration(int iteration)
```
    Sets the current iteration number
    
    Parameters:
    
    iteration - the current iteration number
  - setK
```
public void setK(int k)
```
    Sets the number of clusters
    
    Parameters:
    
    k - the number of clusters
  - setMaxIterations
```
public void setMaxIterations(int maxIterations)
```
    Sets the maximum number of iterations allowed
    
    Parameters:
    
    maxIterations - the maximum number of iterations allowed
  - setOutput
```
public void setOutput(java.lang.String output)
```
    Description copied from class: BaseJob
    
    Sets the job output
    
    Overrides:
    
    setOutput in class BaseJob<K,V>
    
    Parameters:
    
    output - a path
  - setShapeGeneratorClass
```
public void setShapeGeneratorClass(java.lang.Class<? extends ClusterShapeGenerator> shapeGeneratorClass)
```
    Sets the ClusterShapeGenerator subclass to be used
    
    Parameters:
    
    shapeGeneratorClass - a ClusterShapeGenerator subclass

Class KMeansClustering<K,V>

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ARG_CLUSTERS_POINTS

ARG_CRIT_FUN_CLASS

ARG_DELETE_CLUSTER_FILES

ARG_K

ARG_MAX_ITERATIONS

ARG_MAX_MEMBER_DISTANCE

ARG_SHAPE_GEN_CLASS

Constructor Detail

KMeansClustering

Method Detail

configure

getClustersPoints

getCmdOptions

getCritetionFunctionClass

getCurrentCmdArgs

getInClustersPath

getIteration

getK

getMaxIterations

getShapeGeneratorClass

getWorkDirPath

isDeletePreviousClusterFiles

main

processArgs

run

runIteration

runIterations

setClustersPoints

setCritetionFunctionClass

setDeletePreviousClusterFiles

setInClustersPath

setIteration

setK

setMaxIterations

setOutput

setShapeGeneratorClass