javax.datamining.data
Interface Taxonomy

All Superinterfaces:

MiningObject

All Known Subinterfaces:

TaxonomyObject, TaxonomyTable

public interface Taxonomy

extends MiningObject

Taxonomy is an interface that allows the creation and manipulation of taxonomies.

Author:

JSR-73 Java Data Mining Expert Group

See Also:

MiningObject

Method Summary

java.util.Collection	getChildren(java.lang.Object parent) Returns a collection of the children of the specified category.
java.util.Collection	getLeaves() Returns a collection of the leaf categories of the taxonomy.
java.util.Collection	getParents(java.lang.Object child) Returns a collection of the parent categories of the specified category.
java.util.Collection	getRoots() Returns a collection of the root categories of the taxonomy.

Methods inherited from interface javax.datamining.MiningObject

getCreationDate, getCreatorInfo, getDescription, getName, getObjectIdentifier, getObjectType, setDescription

Method Detail

getChildren

public java.util.Collection getChildren(java.lang.Object parent)
                                 throws JDMException

Returns a collection of the children of the specified category.

Parent object must not be null.

Parameters:

parent - The parent category whose child categories are to be returned.

Returns:

Collection

Throws:

JDMException

getLeaves

public java.util.Collection getLeaves()
                               throws JDMException

Returns a collection of the leaf categories of the taxonomy.

If there are no roots, returns an empty collection.

Returns:

Collection

Throws:

JDMException

getParents

public java.util.Collection getParents(java.lang.Object child)
                                throws JDMException

Returns a collection of the parent categories of the specified category.

The child object must not be null.

Parameters:

child - A child category whose parents are to be returned.

Returns:

Collection

Throws:

JDMException

getRoots

public java.util.Collection getRoots()
                              throws JDMException

Returns a collection of the root categories of the taxonomy.

If there are no roots, returns an empty collection.

Returns:

Collection

Throws:

JDMException