com.facetmap
Interface Taxonomy

All Superinterfaces:

Facet

All Known Implementing Classes:

SimpleTaxonomy

public interface Taxonomy

extends Facet

Contains Headings arranged into a tree structure. This is the most common type of Facet.

Method Summary

void	appendHeadingInto(TaxonomicHeading child, TaxonomicHeading parent) Inserts child as a forward Heading of parent, which also provides that parent is a backward Heading of child.
boolean	containsHeading(java.lang.String id)
TaxonomicHeading	createTaxonomicHeading(java.lang.String id, java.lang.String title) Creates a new Heading suitable for adding to this Taxonomy.
Heading	getHeading(java.lang.String id) Retrieves the Heading, with the specified ID, that is contained by this Facet.
int	getHeadingCount()
TaxonomicHeading	getTaxonomicHeading(java.lang.String id)
void	insertHeadingInto(TaxonomicHeading child, TaxonomicHeading parent, int indexWithinParent) Inserts child at the desired position among other children.

Methods inherited from interface com.facetmap.Facet

doAddToFacetSpace, getId, getRootHeading, getTitle, setTitle

Method Detail

getHeading

public Heading getHeading(java.lang.String id)
                   throws UnknownReferenceException

Description copied from interface: Facet

Retrieves the Heading, with the specified ID, that is contained by this Facet. If the facet doesn't recognize the ID, it will throw UnknownReferenceException.

Specified by:

getHeading in interface Facet

Throws:

UnknownReferenceException

getTaxonomicHeading

public TaxonomicHeading getTaxonomicHeading(java.lang.String id)
                                     throws UnknownReferenceException

Throws:

UnknownReferenceException

containsHeading

public boolean containsHeading(java.lang.String id)

getHeadingCount

public int getHeadingCount()

createTaxonomicHeading

public TaxonomicHeading createTaxonomicHeading(java.lang.String id,
                                               java.lang.String title)

Creates a new Heading suitable for adding to this Taxonomy.

appendHeadingInto

public void appendHeadingInto(TaxonomicHeading child,
                              TaxonomicHeading parent)
                       throws java.lang.IllegalArgumentException

Inserts child as a forward Heading of parent, which also provides that parent is a backward Heading of child.

Throws:

java.lang.IllegalArgumentException

insertHeadingInto

public void insertHeadingInto(TaxonomicHeading child,
                              TaxonomicHeading parent,
                              int indexWithinParent)
                       throws java.lang.IllegalArgumentException

Inserts child at the desired position among other children.

Throws:

java.lang.IllegalArgumentException