net.ontopia.topicmaps.impl.basic.index

Class NameIndex

java.lang.Object

net.ontopia.topicmaps.impl.utils.AbstractIndex

net.ontopia.topicmaps.impl.utils.BasicIndex

net.ontopia.topicmaps.impl.basic.index.NameIndex

All Implemented Interfaces:

IndexIF, NameIndexIF, EventListenerIF

public class NameIndex
extends BasicIndex
implements NameIndexIF

INTERNAL: The basic dynamic name index implementation.

Nested Class Summary

Nested classes/interfaces inherited from class net.ontopia.topicmaps.impl.utils.BasicIndex

BasicIndex.EventHandler<K,V>, BasicIndex.TypedPredicate

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionMap<String,TopicNameIF>	basenames
protected CollectionMap<String,VariantNameIF>	variants

Fields inherited from class net.ontopia.topicmaps.impl.utils.BasicIndex

handlers

Method Summary

Modifier and Type	Method and Description
Collection<TopicNameIF>	getTopicNames(String value) PUBLIC: Gets all topic names that have the given name value (in any scope).
Collection<TopicNameIF>	getTopicNames(String value, TopicIF topicNameType) PUBLIC: Gets all topic names that have the given name value (in any scope) and topicNameType.
Collection<VariantNameIF>	getVariants(String value) INTERNAL: Gets all variants that have the specified value independent of datatype.
Collection<VariantNameIF>	getVariants(String value, LocatorIF datatype) INTERNAL: Gets all variants that have the specified value and datatype.

Methods inherited from class net.ontopia.topicmaps.impl.utils.BasicIndex

getIndex, processEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

basenames

protected CollectionMap<String,TopicNameIF> basenames

variants

protected CollectionMap<String,VariantNameIF> variants

Method Detail

getTopicNames

public Collection<TopicNameIF> getTopicNames(String value)

Description copied from interface: NameIndexIF

PUBLIC: Gets all topic names that have the given name value (in any scope).

Specified by:

getTopicNames in interface NameIndexIF

Parameters:

value - A string; the value of a topic name.

Returns:

A collection of TopicNameIF objects with the given name value.

getTopicNames

public Collection<TopicNameIF> getTopicNames(String value,
                                             TopicIF topicNameType)

Description copied from interface: NameIndexIF

PUBLIC: Gets all topic names that have the given name value (in any scope) and topicNameType.

Specified by:

getTopicNames in interface NameIndexIF

Parameters:

value - A string; the value of a topic name

topicNameType - A TopicIF; the type of a topic name

Returns:

A collection of TopicNameIF objects with the given name value and type.

getVariants

public Collection<VariantNameIF> getVariants(String value)

Description copied from interface: NameIndexIF

INTERNAL: Gets all variants that have the specified value independent of datatype.

Specified by:

getVariants in interface NameIndexIF

Returns:

A collection of VariantNameIF objects.

getVariants

public Collection<VariantNameIF> getVariants(String value,
                                             LocatorIF datatype)

Description copied from interface: NameIndexIF

INTERNAL: Gets all variants that have the specified value and datatype.

Specified by:

getVariants in interface NameIndexIF

Returns:

A collection of VariantNameIF objects.