ontopoly.model
Class TopicMap

java.lang.Object
  ontopoly.model.TopicMap

public class TopicMap
extends java.lang.Object

INTERNAL: Represents an Ontopoly topic map.

Constructor Summary

TopicMap(TopicMapIF topicMapIF, java.lang.String topicMapId)

Method Summary

boolean	containsOntology()
AssociationType	createAssociationType(java.lang.String name)
NameType	createNameType(java.lang.String name)
OccurrenceType	createOccurrenceType(java.lang.String name)
RoleType	createRoleType(java.lang.String name)
TopicType	createTopicType(java.lang.String name)
DeclarationContextIF	getDeclarationContext()
protected NameField	getDefaultNameField()
java.lang.String	getId() Returns the Id of the topic map reference in the topic map registry.
java.util.List<IdentityField>	getIdentityFields()
java.lang.String	getName() Returns the name of the topic map, or null if it has none.
java.util.List<NameField>	getNameFields()
java.util.List<OccurrenceField>	getOccurrenceFields()
float	getOntologyVersion() Returns the version of the Ontopoly meta-ontology used in this topic map.
java.util.List<QueryField>	getQueryFields()
QueryProcessorIF	getQueryProcessor()
Topic	getReifier()
java.util.List<RoleField>	getRoleFields()
java.util.List<TopicType>	getRootTopicTypes() Returns a list of the topic types that is not a system topic type.
Topic	getTopicById(java.lang.String id)
TopicIF	getTopicIFById(java.lang.String id)
TopicMapIF	getTopicMapIF()
TopicType	getTopicTypeById(java.lang.String id)
java.util.List<TopicType>	getTopicTypes() Returns a list of the topic types that is not a system topic type.
java.util.List<TopicType>	getTopicTypesWithLargeInstanceSets() Returns a list of the topic types that is not a system topic type.
boolean	isDeleteable()
boolean	isSaveable()
protected TopicIF	makeReifier()
<T> QueryMapper<T>	newQueryMapper(java.lang.Class<T> type)
<T> QueryMapper<T>	newQueryMapperNoWrap()
void	save()
java.util.List<Topic>	searchAll(java.lang.String searchTerm) Returns the topics that matches the given search term.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopicMap

public TopicMap(TopicMapIF topicMapIF,
                java.lang.String topicMapId)

Method Detail

getDeclarationContext

public DeclarationContextIF getDeclarationContext()

getQueryProcessor

public QueryProcessorIF getQueryProcessor()

containsOntology

public boolean containsOntology()

isDeleteable

public boolean isDeleteable()

getTopicMapIF

public TopicMapIF getTopicMapIF()

newQueryMapperNoWrap

public <T> QueryMapper<T> newQueryMapperNoWrap()

newQueryMapper

public <T> QueryMapper<T> newQueryMapper(java.lang.Class<T> type)

getTopicIFById

public TopicIF getTopicIFById(java.lang.String id)

getTopicById

public Topic getTopicById(java.lang.String id)

getTopicTypeById

public TopicType getTopicTypeById(java.lang.String id)

getReifier

public Topic getReifier()

makeReifier

protected TopicIF makeReifier()

getName

public java.lang.String getName()

Returns the name of the topic map, or null if it has none.

getOntologyVersion

public float getOntologyVersion()

Returns the version of the Ontopoly meta-ontology used in this topic map.

getId

public java.lang.String getId()

Returns the Id of the topic map reference in the topic map registry.

getTopicTypes

public java.util.List<TopicType> getTopicTypes()

Returns a list of the topic types that is not a system topic type.

getRootTopicTypes

public java.util.List<TopicType> getRootTopicTypes()

Returns a list of the topic types that is not a system topic type.

getTopicTypesWithLargeInstanceSets

public java.util.List<TopicType> getTopicTypesWithLargeInstanceSets()

Returns a list of the topic types that is not a system topic type.

getOccurrenceFields

public java.util.List<OccurrenceField> getOccurrenceFields()

getRoleFields

public java.util.List<RoleField> getRoleFields()

getNameFields

public java.util.List<NameField> getNameFields()

getIdentityFields

public java.util.List<IdentityField> getIdentityFields()

getQueryFields

public java.util.List<QueryField> getQueryFields()

isSaveable

public boolean isSaveable()

save

public void save()

createTopicType

public TopicType createTopicType(java.lang.String name)

getDefaultNameField

protected NameField getDefaultNameField()

createNameType

public NameType createNameType(java.lang.String name)

createOccurrenceType

public OccurrenceType createOccurrenceType(java.lang.String name)

createAssociationType

public AssociationType createAssociationType(java.lang.String name)

createRoleType

public RoleType createRoleType(java.lang.String name)

searchAll

public java.util.List<Topic> searchAll(java.lang.String searchTerm)

Returns the topics that matches the given search term. Only topics of allowed player types are returned.

Returns:

a collection of Topic objects