|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.ontopia.topicmaps.utils.NameGrabber
public class NameGrabber
INTERNAL: Grabber that grabs the most suitable name from a topic, measured by whether it contains a particular theme in its scope. If the topic has a variant name with the given theme the belonging basename will be chosen. If not, the base name in the least constrained scope will be chosen.
Field Summary | |
---|---|
protected boolean |
grabOnlyTopicName
INTERNAL: Determine if grab should deliver only the most appropiate basename even if there is a more apropiate variant. |
protected boolean |
indicatorVariant
|
protected Collection<TopicIF> |
scope
INTERNAL: Alternatively to themeIndicator the
basename scope (collection of TopicIF objects) to decide
suitablity can be setup instantly. |
protected LocatorIF |
themeIndicator
PROTECTED: The subject indicator of the theme used to decide suitability. |
protected Collection<TopicIF> |
variantScope
INTERNAL: A collection containing topic themes used for specifying the variant name scope. |
Constructor Summary | |
---|---|
NameGrabber(Collection<TopicIF> scope)
INTERNAL: Creates the grabber and sets the comparator to be a ScopedIFComparator using the specified scope. |
|
NameGrabber(Collection<TopicIF> basenameScope,
Collection<TopicIF> variantScope)
INTERNAL: Creates the grabber and sets the comparator to be a ScopedIFComparator using the specified scope. |
|
NameGrabber(Collection<TopicIF> basenameScope,
Collection<TopicIF> variantScope,
boolean grabOnlyTopicName)
INTERNAL: Creates the grabber and sets the comparator to be a ScopedIFComparator using the specified scope. |
|
NameGrabber(LocatorIF themeIndicator)
INTERNAL: Creates the grabber and sets the comparator to be a ScopedIFComparator using the least constrained scope. |
|
NameGrabber(LocatorIF themeIndicator,
boolean variant)
PUBLIC: Creates the grabber and sets the comparator to be a ScopedIFComparator using the least constrained scope. |
Method Summary | |
---|---|
boolean |
getGrabOnlyTopicName()
INTERNAL: Gets the grab policy. |
NameIF |
grab(TopicIF topic)
INTERNAL: Grabs the most appropiate base name (or if grabOnlyTopicName is false allow also to return the
most appropiate VariantIF instance). |
void |
setGrabOnlyTopicName(boolean grabOnlyTopicName)
INTERNAL: Sets the grab policy, if only instances of BasenameIF should be returned by grab, or also the more appropiate VariantIF. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected LocatorIF themeIndicator
protected boolean indicatorVariant
protected Collection<TopicIF> scope
themeIndicator
the
basename scope (collection of TopicIF objects) to decide
suitablity can be setup instantly.
protected Collection<TopicIF> variantScope
protected boolean grabOnlyTopicName
Constructor Detail |
---|
public NameGrabber(LocatorIF themeIndicator)
public NameGrabber(LocatorIF themeIndicator, boolean variant)
variant
- Whether to use the indicator to set the variant
scope (if false it is used for the base name scope)public NameGrabber(Collection<TopicIF> scope)
public NameGrabber(Collection<TopicIF> basenameScope, Collection<TopicIF> variantScope)
public NameGrabber(Collection<TopicIF> basenameScope, Collection<TopicIF> variantScope, boolean grabOnlyTopicName)
grabOnlyTopicName
to
specify the policy) that have most in common with specified
scope.
Method Detail |
---|
public void setGrabOnlyTopicName(boolean grabOnlyTopicName)
public boolean getGrabOnlyTopicName()
setGrabOnlyTopicName(boolean)
public NameIF grab(TopicIF topic)
grabOnlyTopicName
is false allow also to return the
most appropiate VariantIF instance). The name returned is the
first suitable base name belonging to a variant name found, when
the basenames of the give topic have been sorted using the
comparator. If there is no suitable base name belonging to a
variant name, then the last base name found is returned,
corresponding to the least constrained scope.
grab
in interface GrabberIF<TopicIF,NameIF>
object
- The topic whose name is being grabbed; formally an object.
throws
- OntopiaRuntimeException if object is not a topic.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |