Full index

Package indexes

• core
• index

addItemIdentifier

Construct::addItemIdentifier() in Construct.interface.php

Adds an item identifier.

addSubjectIdentifier

Topic::addSubjectIdentifier() in Topic.interface.php

Adds a subject identifier to this topic.

addSubjectLocator

Topic::addSubjectLocator() in Topic.interface.php

Adds a subject locator to this topic.

addTheme

Scoped::addTheme() in Scoped.interface.php

Adds a Topic to the scope.

addType

Topic::addType() in Topic.interface.php

Adds a type to this topic.

Association

Association in Association.interface.php

Represents an association item.

Association.interface.php

Association.interface.php in Association.interface.php

close

TopicMapSystem::close() in TopicMapSystem.interface.php

Closes the Topic Maps system.

close

Index::close() in Index.interface.php

Closes the index.

close

TopicMap::close() in TopicMap.interface.php

Closes use of this topic map instance.

config.php

config.php in config.php

Construct

Construct in Construct.interface.php

Base interface for all Topic Maps constructs.

Construct.interface.php

Construct.interface.php in Construct.interface.php

createAssociation

TopicMap::createAssociation() in TopicMap.interface.php

Creates an Association in this topic map with the specified type and scope.

createName

Topic::createName() in Topic.interface.php

Creates a Name for this topic with the specified value, type, and scope.

createOccurrence

Topic::createOccurrence() in Topic.interface.php

Creates an Occurrence for this topic with the specified type, value, datatype, and scope.

createRole

Association::createRole() in Association.interface.php

Creates a new Role representing a role in this association.

createTopic

TopicMap::createTopic() in TopicMap.interface.php

Returns a Topic instance with an automatically generated item identifier.

createTopicByItemIdentifier

TopicMap::createTopicByItemIdentifier() in TopicMap.interface.php

Returns a Topic instance with the specified item identifier.

createTopicBySubjectIdentifier

TopicMap::createTopicBySubjectIdentifier() in TopicMap.interface.php

Returns a Topic instance with the specified subject identifier.

createTopicBySubjectLocator

TopicMap::createTopicBySubjectLocator() in TopicMap.interface.php

Returns a Topic instance with the specified subject locator.

createTopicMap

TopicMapSystem::createTopicMap() in TopicMapSystem.interface.php

Creates a new TopicMap and stores it within the system under the specified URI.

createVariant

Name::createVariant() in Name.interface.php

Creates an IVariant of this topic name with the specified value, datatype, and scope.

DatatypeAware.interface.php

DatatypeAware.interface.php in DatatypeAware.interface.php

DatatypeAware

DatatypeAware in DatatypeAware.interface.php

Common base interface for Occurrences and IVariants.

equals

Construct::equals() in Construct.interface.php

Returns true if the other construct is equal to this one, false otherwise.

FactoryConfigurationException.class.php

FactoryConfigurationException.class.php in FactoryConfigurationException.class.php

FeatureNotRecognizedException.class.php

FeatureNotRecognizedException.class.php in FeatureNotRecognizedException.class.php

FeatureNotSupportedException.class.php

FeatureNotSupportedException.class.php in FeatureNotSupportedException.class.php

FactoryConfigurationException

FactoryConfigurationException in FactoryConfigurationException.class.php

Exception thrown when a TopicMapSystemFactory instance cannot be instantiated through the method TopicMapSystemFactory::newInstance().

FeatureNotRecognizedException

FeatureNotRecognizedException in FeatureNotRecognizedException.class.php

Exception thrown when the TopicMapSystemFactory does not recognize the name of a feature that the application is trying to enable or disable.

FeatureNotSupportedException

FeatureNotSupportedException in FeatureNotSupportedException.class.php

Exception thrown when the underlying implementation cannot support enabling or disabling a recognized feature. implementations MUST throw a FeatureNotRecognizedException rather than a FeatureNotSupportedException.

getAssociations

TopicMap::getAssociations() in TopicMap.interface.php

Returns all Associations contained in this topic map.

getAssociations

TypeInstanceIndex::getAssociations() in TypeInstanceIndex.interface.php

Returns the associations in the topic map whose type property equals $type.

getAssociations

ScopedIndex::getAssociations() in ScopedIndex.interface.php

Returns the Associations in the topic map whose scope property equals one of those themes at least.

getAssociationThemes

ScopedIndex::getAssociationThemes() in ScopedIndex.interface.php

Returns the Topics in the topic map used in the scope property of Associations.

getAssociationTypes

TypeInstanceIndex::getAssociationTypes() in TypeInstanceIndex.interface.php

Returns the topics in the topic map used in the type property of Associations.

getConstructById

TopicMap::getConstructById() in TopicMap.interface.php

Returns a Construct by its (system specific) identifier.

getConstructByItemIdentifier

TopicMap::getConstructByItemIdentifier() in TopicMap.interface.php

Returns a Construct by its item identifier.

getDatatype

DatatypeAware::getDatatype() in DatatypeAware.interface.php

Returns the URI identifying the datatype of the value.

getExisting

IdentityConstraintException::getExisting() in IdentityConstraintException.class.php

Returns the Construct which already has the identity represented by the locator in getLocator().

getFeature

TopicMapSystem::getFeature() in TopicMapSystem.interface.php

Returns the value of the feature specified by $featureName for this TopicMapSystem instance.

getFeature

TopicMapSystemFactory::getFeature() in TopicMapSystemFactory.class.php

Returns the particular feature requested for in the underlying implementation of TopicMapSystem.

getId

Construct::getId() in Construct.interface.php

Returns the identifier of this construct.

getIndex

TopicMap::getIndex() in TopicMap.interface.php

Returns the specified index.

getItemIdentifiers

Construct::getItemIdentifiers() in Construct.interface.php

Returns the item identifiers of this Topic Maps construct.

getLocator

TopicMap::getLocator() in TopicMap.interface.php

Returns the storage address that is defined in TopicMapSystem::createTopicMap().

getLocator

IdentityConstraintException::getLocator() in IdentityConstraintException.class.php

Returns the locator representing the identity that caused the exception.

getLocators

TopicMapSystem::getLocators() in TopicMapSystem.interface.php

Returns all storage addresses of TopicMap instances known by this Topic Maps system.

getNames

Topic::getNames() in Topic.interface.php

Returns the Names of this topic.

getNames

ScopedIndex::getNames() in ScopedIndex.interface.php

Returns the Names in the topic map whose scope property equals one of those themes at least.

getNames

LiteralIndex::getNames() in LiteralIndex.interface.php

Retrieves the topic names in the topic map which have a value equal to $value.

getNames

TypeInstanceIndex::getNames() in TypeInstanceIndex.interface.php

Returns the topic names in the topic map whose type property equals $type.

getNameThemes

ScopedIndex::getNameThemes() in ScopedIndex.interface.php

Returns the Topics in the topic map used in the scope property of Names.

getNameTypes

TypeInstanceIndex::getNameTypes() in TypeInstanceIndex.interface.php

Returns the topics in the topic map used in the type property of Names.

getOccurrences

Topic::getOccurrences() in Topic.interface.php

Returns the Occurrences of this topic.

getOccurrences

TypeInstanceIndex::getOccurrences() in TypeInstanceIndex.interface.php

Returns the occurrences in the topic map whose type property equals $type.

getOccurrences

LiteralIndex::getOccurrences() in LiteralIndex.interface.php

Returns the Occurrences in the topic map whose value property matches $value and whose datatye is $datatype.

getOccurrences

ScopedIndex::getOccurrences() in ScopedIndex.interface.php

Returns the Occurrences in the topic map whose scope property equals one of those themes at least.

getOccurrenceThemes

ScopedIndex::getOccurrenceThemes() in ScopedIndex.interface.php

Returns the Topics in the topic map used in the scope property of Occurrences.

getOccurrenceTypes

TypeInstanceIndex::getOccurrenceTypes() in TypeInstanceIndex.interface.php

Returns the topics in the topic map used in the type property of Occurrences.

getParent

Construct::getParent() in Construct.interface.php

Returns the parent of this construct.

getPlayer

Role::getPlayer() in Role.interface.php

Returns the Topic playing this role.

getProperty

TopicMapSystem::getProperty() in TopicMapSystem.interface.php

Returns a property in the underlying implementation of TopicMapSystem.

getProperty

TopicMapSystemFactory::getProperty() in TopicMapSystemFactory.class.php

Gets the value of a property in the underlying implementation of TopicMapSystem.

getReified

Topic::getReified() in Topic.interface.php

Returns the Construct which is reified by this topic.

getReifier

Reifiable::getReifier() in Reifiable.interface.php

Returns the reifier of this Construct.

getReporter

ModelConstraintException::getReporter() in ModelConstraintException.class.php

Returns the Construct which has thrown the exception.

getRoles

TypeInstanceIndex::getRoles() in TypeInstanceIndex.interface.php

Returns the roles in the topic map whose type property equals $type.

getRoles

Association::getRoles() in Association.interface.php

Returns the Roles participating in this association.

getRolesPlayed

Topic::getRolesPlayed() in Topic.interface.php

Returns the Roles played by this topic.

getRoleTypes

TypeInstanceIndex::getRoleTypes() in TypeInstanceIndex.interface.php

Returns the topics in the topic map used in the type property of Roles.

getRoleTypes

Association::getRoleTypes() in Association.interface.php

Returns the role types participating in this association.

getScope

Scoped::getScope() in Scoped.interface.php

Returns the Topics which define the scope.

getSubjectIdentifiers

Topic::getSubjectIdentifiers() in Topic.interface.php

Returns the subject identifiers assigned to this topic.

getSubjectLocators

Topic::getSubjectLocators() in Topic.interface.php

Returns the subject locators assigned to this topic.

getTopicBySubjectIdentifier

TopicMap::getTopicBySubjectIdentifier() in TopicMap.interface.php

Returns a topic by its subject identifier.

getTopicBySubjectLocator

TopicMap::getTopicBySubjectLocator() in TopicMap.interface.php

Returns a topic by its subject locator.

getTopicMap

Construct::getTopicMap() in Construct.interface.php

Returns the TopicMap instance to which this Topic Maps construct belongs to.

getTopicMap

TopicMapSystem::getTopicMap() in TopicMapSystem.interface.php

Retrieves a TopicMap managed by this system with the specified storage address $uri.

getTopics

TypeInstanceIndex::getTopics() in TypeInstanceIndex.interface.php

Returns the topics in the topic map whose type property equals one of those types at least.

getTopics

TopicMap::getTopics() in TopicMap.interface.php

Returns all Topics contained in this topic map.

getTopicTypes

TypeInstanceIndex::getTopicTypes() in TypeInstanceIndex.interface.php

Returns the topics in the topic map which are used as type in a "type-instance"-relationship.

getType

Typed::getType() in Typed.interface.php

Returns the type of this construct.

getTypes

Topic::getTypes() in Topic.interface.php

Returns the types of which this topic is an instance of.

getValue

DatatypeAware::getValue() in DatatypeAware.interface.php

Returns the string representation of the value.

getValue

Name::getValue() in Name.interface.php

Returns the value of this name.

getVariants

ScopedIndex::getVariants() in ScopedIndex.interface.php

Returns the IVariants in the topic map whose scope property equals one of those themes at least.

getVariants

Name::getVariants() in Name.interface.php

Returns the IVariants defined for this name.

getVariants

LiteralIndex::getVariants() in LiteralIndex.interface.php

Returns the IVariants in the topic map whose value property matches $value and whose datatye is $datatype.

getVariantThemes

ScopedIndex::getVariantThemes() in ScopedIndex.interface.php

Returns the Topics in the topic map used in the scope property of IVariants.

hasFeature

TopicMapSystemFactory::hasFeature() in TopicMapSystemFactory.class.php

Returns if the particular feature is supported by the TopicMapSystem.

hashCode

Construct::hashCode() in Construct.interface.php

Returns a hash code value.

IdentityConstraintException.class.php

IdentityConstraintException.class.php in IdentityConstraintException.class.php

IVariant.interface.php

IVariant.interface.php in IVariant.interface.php

IdentityConstraintException

IdentityConstraintException in IdentityConstraintException.class.php

This exception is used to report identity constraint violations.

Index

Index in Index.interface.php

Base interface for all indices.

Index.interface.php

Index.interface.php in Index.interface.php

isAutoUpdated

Index::isAutoUpdated() in Index.interface.php

Indicates whether the index is updated automatically.

isOpen

Index::isOpen() in Index.interface.php

Indicates if the index is open.

IVariant

IVariant in IVariant.interface.php

Represents a variant item.

LiteralIndex.interface.php

LiteralIndex.interface.php in LiteralIndex.interface.php

LiteralIndex

LiteralIndex in LiteralIndex.interface.php

Index for literal values stored in a topic map.

ModelConstraintException.class.php

ModelConstraintException.class.php in ModelConstraintException.class.php

mergeIn

Topic::mergeIn() in Topic.interface.php

Merges another topic into this topic.

mergeIn

TopicMap::mergeIn() in TopicMap.interface.php

Merges the topic map $other into this topic map.

ModelConstraintException

ModelConstraintException in ModelConstraintException.class.php

This exception is used to report Topic Maps Data Model (TMDM) (http://www.

Name.interface.php

Name.interface.php in Name.interface.php

Name

Name in Name.interface.php

Represents a topic name item.

newInstance

TopicMapSystemFactory::newInstance() in TopicMapSystemFactory.class.php

Obtains a new instance of TopicMapSystemFactory.

newTopicMapSystem

TopicMapSystemFactory::newTopicMapSystem() in TopicMapSystemFactory.class.php

Creates a new TopicMapSystem instance using the currently configured factory parameters.

Occurrence.interface.php

Occurrence.interface.php in Occurrence.interface.php

Occurrence

Occurrence in Occurrence.interface.php

Represents an occurrence item.

open

Index::open() in Index.interface.php

Opens the index.

PHPTMAPIException.class.php

PHPTMAPIException.class.php in PHPTMAPIException.class.php

PHPTMAPIRuntimeException.class.php

PHPTMAPIRuntimeException.class.php in PHPTMAPIRuntimeException.class.php

PHPTMAPIException

PHPTMAPIException in PHPTMAPIException.class.php

The base class for all standard (non run-time) exceptions thrown by a Topic Maps system.

PHPTMAPIRuntimeException

PHPTMAPIRuntimeException in PHPTMAPIRuntimeException.class.php

Instances of this exception class should be thrown in cases where there is an error in the underlying topic map processing system or when integrity constraints are violated.

Reifiable.interface.php

Reifiable.interface.php in Reifiable.interface.php

Role.interface.php

Role.interface.php in Role.interface.php

Reifiable

Reifiable in Reifiable.interface.php

Indicates that a Construct is reifiable.

reindex

Index::reindex() in Index.interface.php

Synchronizes the index with data in the topic map.

remove

Construct::remove() in Construct.interface.php

Deletes this construct from its parent container.

removeItemIdentifier

Construct::removeItemIdentifier() in Construct.interface.php

Removes an item identifier.

removeSubjectIdentifier

Topic::removeSubjectIdentifier() in Topic.interface.php

Removes a subject identifier from this topic.

removeSubjectLocator

Topic::removeSubjectLocator() in Topic.interface.php

Removes a subject locator from this topic.

removeTheme

Scoped::removeTheme() in Scoped.interface.php

Removes a Topic from the scope.

removeType

Topic::removeType() in Topic.interface.php

Removes a type from this topic.

Role

Role in Role.interface.php

Represents an association role item.

Scoped.interface.php

Scoped.interface.php in Scoped.interface.php

ScopedIndex.interface.php

ScopedIndex.interface.php in ScopedIndex.interface.php

Scoped

Scoped in Scoped.interface.php

Indicates that a statement (a Topic Maps construct) has a scope.

ScopedIndex

ScopedIndex in ScopedIndex.interface.php

Index for Scoped statements and their scope.

setFeature

TopicMapSystemFactory::setFeature() in TopicMapSystemFactory.class.php

Sets a particular feature in the underlying implementation of TopicMapSystem.

setPlayer

Role::setPlayer() in Role.interface.php

Sets the role player.

setProperty

TopicMapSystemFactory::setProperty() in TopicMapSystemFactory.class.php

Sets a property in the underlying implementation of TopicMapSystem.

setReifier

Reifiable::setReifier() in Reifiable.interface.php

Sets the reifier of this Construct.

setType

Typed::setType() in Typed.interface.php

Sets the type of this construct.

setValue

Name::setValue() in Name.interface.php

Sets the value of this name.

setValue

DatatypeAware::setValue() in DatatypeAware.interface.php

Sets the value and the datatype.

Topic.interface.php

Topic.interface.php in Topic.interface.php

TopicInUseException.class.php

TopicInUseException.class.php in TopicInUseException.class.php

TopicMap.interface.php

TopicMap.interface.php in TopicMap.interface.php

TopicMapExistsException.class.php

TopicMapExistsException.class.php in TopicMapExistsException.class.php

TopicMapSystem.interface.php

TopicMapSystem.interface.php in TopicMapSystem.interface.php

TopicMapSystemFactory.class.php

TopicMapSystemFactory.class.php in TopicMapSystemFactory.class.php

Typed.interface.php

Typed.interface.php in Typed.interface.php

TypeInstanceIndex.interface.php

TypeInstanceIndex.interface.php in TypeInstanceIndex.interface.php

Topic

Topic in Topic.interface.php

Represents a topic item.

TopicInUseException

TopicInUseException in TopicInUseException.class.php

Thrown when an attempt is made to remove a Topic which is being used as a type, as a reifier, or as a role player in an association, or in a scope.

TopicMap

TopicMap in TopicMap.interface.php

Represents a topic map item.

TopicMapExistsException

TopicMapExistsException in TopicMapExistsException.class.php

Exception thrown when an attempt is made to create a new TopicMap under a storage address (a URI) that is already assigned to another TopicMap in the same TopicMapSystem.

TopicMapSystem

TopicMapSystem in TopicMapSystem.interface.php

A generic interface to a Topic Maps system.

TopicMapSystemFactory

TopicMapSystemFactory in TopicMapSystemFactory.class.php

This factory class provides access to a Topic Maps system.

Typed

Typed in Typed.interface.php

Indicates that a Topic Maps construct is typed.

TypeInstanceIndex

TypeInstanceIndex in TypeInstanceIndex.interface.php

Index for type-instance relationships between Topics and for Typed Topic Maps constructs.

$_existing

IdentityConstraintException::$_existing in IdentityConstraintException.class.php

The Construct which already has the identity represented by the locator in getLocator().

$_locator

IdentityConstraintException::$_locator in IdentityConstraintException.class.php

The locator representing the identity that caused the exception.

$_reporter

ModelConstraintException::$_reporter in ModelConstraintException.class.php

The Construct which has thrown the exception.

_getImplementationClassName

TopicMapSystemFactory::_getImplementationClassName() in TopicMapSystemFactory.class.php

Returns the class name of the TopicMapSystemFactory implementation as defined in the PHPTMAPI configuration file.

__construct

TopicInUseException::__construct() in TopicInUseException.class.php

Constructor.

__construct

ModelConstraintException::__construct() in ModelConstraintException.class.php

Constructor.

__construct

IdentityConstraintException::__construct() in IdentityConstraintException.class.php

Constructor.