ontopoly.model

Class TopicMap

java.lang.Object

ontopoly.model.TopicMap

public class TopicMap
extends Object

INTERNAL: Represents an Ontopoly topic map.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DC
protected static String	ON
protected static String	TECH
protected static String	TEST
protected static String	TMDM
protected static String	XSD
protected static String	XTM

Constructor Summary

Constructors

Constructor and Description
TopicMap(TopicMapIF topicMapIF, String topicMapId)

Method Summary

Modifier and Type	Method and Description
boolean	containsOntology()
AssociationType	createAssociationType(String name)
protected TopicIF	createNamedTopic(String name, TopicIF type)
NameType	createNameType(String name)
OccurrenceType	createOccurrenceType(String name)
RoleType	createRoleType(String name)
TopicType	createTopicType(String name)
DeclarationContextIF	getDeclarationContext()
protected NameField	getDefaultNameField()
String	getId() Returns the Id of the topic map reference in the topic map registry.
List<IdentityField>	getIdentityFields()
String	getName() Returns the name of the topic map, or null if it has none.
List<NameField>	getNameFields()
List<OccurrenceField>	getOccurrenceFields()
float	getOntologyVersion() Returns the version of the Ontopoly meta-ontology used in this topic map.
List<QueryField>	getQueryFields()
QueryProcessorIF	getQueryProcessor()
Topic	getReifier()
List<RoleField>	getRoleFields()
List<TopicType>	getRootTopicTypes() Returns a list of the topic types that is not a system topic type.
Topic	getTopicById(String id)
TopicIF	getTopicIFById(String id)
TopicMapIF	getTopicMapIF()
protected String	getTopicName(TopicIF topic, AbstractTypingTopic fallback) Package-internal method to get the name of a topic.
TopicType	getTopicTypeById(String id)
List<TopicType>	getTopicTypes() Returns a list of the topic types that is not a system topic type.
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(Class<T> type)
<T> QueryMapper<T>	newQueryMapperNoWrap()
void	save()
List<Topic>	searchAll(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

Field Detail

ON

protected static final String ON

See Also:

Constant Field Values

XTM

protected static final String XTM

See Also:

Constant Field Values

TEST

protected static final String TEST

See Also:

Constant Field Values

TECH

protected static final String TECH

See Also:

Constant Field Values

DC

protected static final String DC

See Also:

Constant Field Values

XSD

protected static final String XSD

See Also:

Constant Field Values

TMDM

protected static final String TMDM

See Also:

Constant Field Values

Constructor Detail

TopicMap

public TopicMap(TopicMapIF topicMapIF,
                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(Class<T> type)

getTopicIFById

public TopicIF getTopicIFById(String id)

getTopicById

public Topic getTopicById(String id)

getTopicTypeById

public TopicType getTopicTypeById(String id)

getReifier

public Topic getReifier()

makeReifier

protected TopicIF makeReifier()

getName

public 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 String getId()

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

getTopicTypes

public List<TopicType> getTopicTypes()

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

getRootTopicTypes

public List<TopicType> getRootTopicTypes()

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

getTopicTypesWithLargeInstanceSets

public List<TopicType> getTopicTypesWithLargeInstanceSets()

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

getOccurrenceFields

public List<OccurrenceField> getOccurrenceFields()

getRoleFields

public List<RoleField> getRoleFields()

getNameFields

public List<NameField> getNameFields()

getIdentityFields

public List<IdentityField> getIdentityFields()

getQueryFields

public List<QueryField> getQueryFields()

isSaveable

public boolean isSaveable()

save

public void save()

createNamedTopic

protected TopicIF createNamedTopic(String name,
                                   TopicIF type)

createTopicType

public TopicType createTopicType(String name)

getDefaultNameField

protected NameField getDefaultNameField()

createNameType

public NameType createNameType(String name)

createOccurrenceType

public OccurrenceType createOccurrenceType(String name)

createAssociationType

public AssociationType createAssociationType(String name)

createRoleType

public RoleType createRoleType(String name)

searchAll

public List<Topic> searchAll(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

getTopicName

protected String getTopicName(TopicIF topic,
                              AbstractTypingTopic fallback)

Package-internal method to get the name of a topic. Introduced in Ontopia 5.1 for field definitions. Not used everywhere because I don't understand the code well enough to do that, and anyway things appear to work properly elsewhere. Should probably use this in Topic.getName(), though.