com.facetmap
Interface Heading

All Known Subinterfaces:

CompoundHeading, DateHeading, GeographyHeading, KeywordHeading, SpectrumHeading, TaxonomyHeading

All Known Implementing Classes:

CompoundIndexedHeading, DateHeadingImpl, IndexedHeading, ResourceIdHeading, SimpleCompoundHeading, SimpleDateHeading, SimpleHeading, SimpleSpectrumHeading, SimpleTaxonomyHeading, SpectrumHeadingImpl

public interface Heading

A possible classification that a Resource may have; a member of a Facet structure; a value in a Facet.

There is no standard term in facet parlance for this concept; we call it a Heading. Any given Resource may be mapped 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 this Heading's Facet at all. In that case, the Resource is bound to the root Heading of the Facet [see Facet.getRootHeading() ].

See Also:

Facet

Method Summary

Heading	getBackwardHeading() See Facet for the definition of a backward heading.
Facet	getFacet() Facet to which this Heading belongs.
java.util.Iterator	getForwardHeadings() See Facet for the definition of a forward heading.
java.lang.String	getId() Unique identifier of a predefined Heading.
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.

Method Detail

getId

java.lang.String getId()

Unique identifier of a predefined Heading. This can be null if the Heading is not explicitly defined as an input to the Facetmap engine.

getTitle

java.lang.String getTitle()

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

getFacet

Facet getFacet()

Facet to which this Heading belongs. A Heading must belong to a Facet.

getForwardHeadings

java.util.Iterator getForwardHeadings()

See Facet for the definition of a forward heading. This method returns an empty Iterator if the Heading has no forward headings.

getBackwardHeading

Heading getBackwardHeading()

See Facet for the definition of a backward heading. This method returns null if the Heading has no backward heading.

isRoot

boolean isRoot()

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

See Also:

Facet.getRootHeading()