com.facetmap
Interface Heading

All Known Subinterfaces:

SpectrumHeading, TaxonomicHeading

All Known Implementing Classes:

SimpleTaxHeading

public interface Heading

A possible attribute that a Resource may have; a node in a Facet structure.

There is no standard term in facet parlance for this concept; we call it a Heading. Any given Resource may be bound to (have the quality defined by) this Heading, or it may not -- but it is bound to some Heading in the same Facet.

The Resource may, of course, not be relevant to a given Facet. In that case, the Resource is bound to the root Heading of the Facet [see Facet.getRootHeading() ].

Method Summary

java.util.Enumeration	getBackwardHeadings() An empty Enumeration is returned if there are no headings to return.
Facet	getFacet() Structure to which this Heading belongs.
java.util.Enumeration	getForwardHeadings() An empty Enumeration is returned if there are no headings to return.
java.lang.String	getId() Unique identifier.
java.lang.String	getTitle() The descriptive name of this Heading, for display to users.
boolean	isRoot() Returns true if this Heading is the root, the starting Heading, of its Facet.
void	setTitle(java.lang.String title)

Method Detail

getId

public java.lang.String getId()

Unique identifier.

getTitle

public java.lang.String getTitle()

The descriptive name of this Heading, for display to users.

setTitle

public void setTitle(java.lang.String title)

getFacet

public Facet getFacet()

Structure to which this Heading belongs. Returns null if the Heading has not been added to a Facet.

getForwardHeadings

public java.util.Enumeration getForwardHeadings()

An empty Enumeration is returned if there are no headings to return.

getBackwardHeadings

public java.util.Enumeration getBackwardHeadings()

An empty Enumeration is returned if there are no headings to return.

isRoot

public boolean isRoot()

Returns true if this Heading is the root, the starting Heading, of its Facet.

See Also:

Facet.getRootHeading()