org.tmapi.index.core
Interface VariantsIndex

All Superinterfaces:

Index, TopicMapSystem.ConfigurableHelperObject

public interface VariantsIndex

extends Index

An index of all Variant instances in the TopicMap by their resource reference or resource data.

Since:

1.0

Method Summary

java.util.Collection	getVariantsByResource(Locator loc) Returns the Variants in the topic map whose resource locator matches loc.
java.util.Collection	getVariantsByValue(java.lang.String value) Returns the Variants in the topic map whose value property matches value The return value may be an empty Collection but must never be null.

Methods inherited from interface org.tmapi.index.Index

close, getFlags, isOpen, open, reindex

Methods inherited from interface org.tmapi.core.TopicMapSystem.ConfigurableHelperObject

configure

Method Detail

getVariantsByResource

public java.util.Collection getVariantsByResource(Locator loc)

Returns the Variants in the topic map whose resource locator matches loc. The return value may be an empty Collection but must never be null.

Parameters:

loc - the Locator used to query the index (MUST NOT be null)

Returns:

a Collection of Variant instances.

getVariantsByValue

public java.util.Collection getVariantsByValue(java.lang.String value)

Returns the Variants in the topic map whose value property matches value The return value may be an empty Collection but must never be null.

Parameters:

value - the data string used to query the index (MUST NOT be null)

Returns:

a Collection of Variant instances.