weka.clusterers.forOPTICSAndDBScan.Databases

Class Database

java.lang.Object

weka.clusterers.forOPTICSAndDBScan.Databases.Database

All Implemented Interfaces:

java.io.Serializable, weka.core.RevisionHandler

public class Database
extends java.lang.Object
implements java.io.Serializable, weka.core.RevisionHandler

Database.java
Authors: Rainer Holzmann, Zhanna Melnikova-Albrecht, Matthias Schubert
Date: Aug 20, 2004
Time: 1:23:38 PM
$ Revision 1.4 $

Version:

$Revision: 10838 $

Author:

Matthias Schubert (schubert@dbs.ifi.lmu.de), Zhanna Melnikova-Albrecht (melnikov@cip.ifi.lmu.de), Rainer Holzmann (holzmann@cip.ifi.lmu.de)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Database(weka.core.DistanceFunction distFunc, weka.core.Instances instances) Constructs a new sequential database and holds the original instances

Method Summary

Modifier and Type	Method and Description
boolean	contains(DataObject dataObject_Query) Tests if the database contains the dataObject_Query
java.util.List	coreDistance(int minPoints, double epsilon, DataObject dataObject) Calculates the coreDistance for the specified DataObject.
java.util.Iterator	dataObjectIterator() Returns an iterator over all the dataObjects in the database
java.util.List	epsilonRangeQuery(double epsilon, DataObject queryDataObject) Performs an epsilon range query for this dataObject
DataObject	getDataObject(java.lang.String key) Select a dataObject from the database
weka.core.Instances	getInstances() Returns the original instances delivered from WEKA
java.lang.String	getRevision() Returns the revision string.
void	insert(DataObject dataObject) Inserts a new dataObject into the database
java.util.List	k_nextNeighbourQuery(int k, double epsilon, DataObject dataObject) Emits the k next-neighbours and performs an epsilon-range-query at the parallel.
java.util.Iterator	keyIterator() Returns an iterator over all the keys
int	size() Returns the size of the database (the number of dataObjects in the database)

Methods inherited from class java.lang.Object

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

Constructor Detail

Database

public Database(weka.core.DistanceFunction distFunc,
                weka.core.Instances instances)

Constructs a new sequential database and holds the original instances

Parameters:

instances -

Method Detail

getDataObject

public DataObject getDataObject(java.lang.String key)

Select a dataObject from the database

Parameters:

key - The key that is associated with the dataObject

Returns:

dataObject

epsilonRangeQuery

public java.util.List epsilonRangeQuery(double epsilon,
                                        DataObject queryDataObject)

Performs an epsilon range query for this dataObject

Parameters:

epsilon - Specifies the range for the query

queryDataObject - The dataObject that is used as query-object for epsilon range query

Returns:

List with all the DataObjects that are within the specified range

k_nextNeighbourQuery

public java.util.List k_nextNeighbourQuery(int k,
                                           double epsilon,
                                           DataObject dataObject)

Emits the k next-neighbours and performs an epsilon-range-query at the parallel. The returned list contains two elements: At index=0 --> list with all k next-neighbours; At index=1 --> list with all dataObjects within epsilon;

Parameters:

k - number of next neighbours

epsilon - Specifies the range for the query

dataObject - the start object

Returns:

list with the k-next neighbours (PriorityQueueElements) and a list with candidates from the epsilon-range-query (EpsilonRange_ListElements)

coreDistance

public java.util.List coreDistance(int minPoints,
                                   double epsilon,
                                   DataObject dataObject)

Calculates the coreDistance for the specified DataObject. The returned list contains three elements: At index=0 --> list with all k next-neighbours; At index=1 --> list with all dataObjects within epsilon; At index=2 --> coreDistance as Double-value

Parameters:

minPoints - minPoints-many neighbours within epsilon must be found to have a non-undefined coreDistance

epsilon - Specifies the range for the query

dataObject - Calculate coreDistance for this dataObject

Returns:

list with the k-next neighbours (PriorityQueueElements) and a list with candidates from the epsilon-range-query (EpsilonRange_ListElements) and the double-value for the calculated coreDistance

size

public int size()

Returns the size of the database (the number of dataObjects in the database)

Returns:

size

keyIterator

public java.util.Iterator keyIterator()

Returns an iterator over all the keys

Returns:

iterator

dataObjectIterator

public java.util.Iterator dataObjectIterator()

Returns an iterator over all the dataObjects in the database

Returns:

iterator

contains

public boolean contains(DataObject dataObject_Query)

Tests if the database contains the dataObject_Query

Parameters:

dataObject_Query - The query-object

Returns:

true if the database contains dataObject_Query, else false

insert

public void insert(DataObject dataObject)

Inserts a new dataObject into the database

Parameters:

dataObject -

getInstances

public weka.core.Instances getInstances()

Returns the original instances delivered from WEKA

Returns:

instances

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Returns:

the revision