[org.phptmapi.core] element index

Package indexes

All elements

top

__construct: TopicMapExistsException::__construct() in TopicMapExistsException.exception.php

Constructor
__construct: TopicInUseException::__construct() in TopicInUseException.exception.php

Constructor
__construct: TMAPIRuntimeException::__construct() in TMAPIRuntimeException.exception.php

Constructor
__construct: TopicMapSystemFactory::__construct() in TopicMapSystemFactory.abstract.php

Constructor
__construct: TopicsMustMergeException::__construct() in TopicsMustMergeException.exception.php

Constructor
__construct: UnsupportedOperationException::__construct() in UnsupportedOperationException.exception.php

Constructor
__construct: UnsupportedHelperObjectException::__construct() in UnsupportedHelperObjectException.exception.php

Constructor
__construct: TMAPIException::__construct() in TMAPIException.exception.php

Constructor
__construct: SubjectLocatorClashException::__construct() in SubjectLocatorClashException.exception.php

Constructor
__construct: FeatureNotSupportedException::__construct() in FeatureNotSupportedException.exception.php

Constructor
__construct: FeatureNotRecognizedException::__construct() in FeatureNotRecognizedException.exception.php

Constructor
__construct: FactoryConfigurationException::__construct() in FactoryConfigurationException.exception.php

Constructor
__construct: HelperObjectConfigurationException::__construct() in HelperObjectConfigurationException.exception.php

Constructor
__construct: HelperObjectInstantiationException::__construct() in HelperObjectInstantiationException.exception.php

Constructor
__construct: ModelConstraintException::__construct() in ModelConstraintException.exception.php

Constructor
__construct: MergeException::__construct() in MergeException.exception.php

Constructor
__construct: DuplicateItemidentifierException::__construct() in DuplicateItemIdentifierException.exception.php

Constructor

top

addItemIdentifier: TopicMapObjectInterface::addItemIdentifier() in TopicMapObject.interface.php

addItemIdentifier: Adds a locator to the item identifiers for this object.
addScopingTopic: ScopedObjectInterface::addScopingTopic() in ScopedObject.interface.php

addScopingTopic: Adds a topic which defines the scope/parameters for this ScopedObjectInterface.
addSubjectIdentifier: TopicInterface::addSubjectIdentifier() in Topic.interface.php

addSubjectIdentifier: Adds the specified locator to the locators that reference the subject-indicating resources of this topic.
addSubjectLocator: TopicInterface::addSubjectLocator() in Topic.interface.php

addSubjectLocator: Adds the specified locator to the locators that reference the subject-constituting resources of this topic.
addType: TopicInterface::addType() in Topic.interface.php

addType: Adds a type to this topic.
AssociationInterface: AssociationInterface in Association.interface.php

Interface AssociationInterface: Represents the topic map association construct.
AssociationRoleInterface: AssociationRoleInterface in AssociationRole.interface.php

Interface AssociationRoleInterface: Represents the topic map member / role construct (known as association role in HyTM).
AssociationRole.interface.php: AssociationRole.interface.php in AssociationRole.interface.php
Association.interface.php: Association.interface.php in Association.interface.php

top

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

close: Closes use of this topic map.
close: TopicMapSystemInterface::close() in TopicMapSystem.interface.php

close: Applications SHOULD call this method when the TopicMapSystemInterface instance is no longer required.
configure: TopicMapSystemConfigurableHelperObjectInterface::configure() in TopicMapSystem.ConfigurableHelperObject.interface.php

configure: Configuration method of the helper object.
createAssociation: TopicMapInterface::createAssociation() in TopicMap.interface.php

createAssociation: Creates a new association in the topic map.
createAssociationRole: AssociationInterface::createAssociationRole() in Association.interface.php

createAssociationRole: Creates a new AssociationRoleInterface representing a role in this association.
createOccurrence: TopicInterface::createOccurrence() in Topic.interface.php

createOccurrence: Creates a new occurrence as a contained object in this topic.
createTopic: TopicMapInterface::createTopic() in TopicMap.interface.php

createTopic: Creates a new topic in the topic map.
createTopicMap: TopicMapSystemInterface::createTopicMap() in TopicMapSystem.interface.php

createTopicMap: Creates a new topic map with a specified base locator.
createTopicName: TopicInterface::createTopicName() in Topic.interface.php

createTopicName: Creates a new typed topic name for this topic.
createUntypedTopicName: TopicInterface::createUntypedTopicName() in Topic.interface.php

createUntypedTopicName: Creates a new untyped name for this topic.
createVariant: TopicNameInterface::createVariant() in TopicName.interface.php

createVariant: Creates a variant of this topic name with the specified resource data string and scopes.

top

DuplicateItemidentifierException: DuplicateItemidentifierException in DuplicateItemIdentifierException.exception.php

public class DuplicateItemidentifierException: Exception is raised when an item identifier is added to a TopicMapObjectInterface, that already exists in this topic map.
DuplicateItemIdentifierException.exception.php: DuplicateItemIdentifierException.exception.php in DuplicateItemIdentifierException.exception.php

top

FactoryConfigurationException: FactoryConfigurationException in FactoryConfigurationException.exception.php

public class FactoryConfigurationException: Exception thrown when a TopicMapSystemFactory instance cannot be instantiated through the method.
FeatureNotRecognizedException: FeatureNotRecognizedException in FeatureNotRecognizedException.exception.php

public class FeatureNotRecognizedException: 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.exception.php

public class FeatureNotSupporteedException: Exception thrown when the underlying implementation cannot support enabling or disabling a recognised feature.
FactoryConfigurationException.exception.php: FactoryConfigurationException.exception.php in FactoryConfigurationException.exception.php
FeatureNotRecognizedException.exception.php: FeatureNotRecognizedException.exception.php in FeatureNotRecognizedException.exception.php
FeatureNotSupportedException.exception.php: FeatureNotSupportedException.exception.php in FeatureNotSupportedException.exception.php

top

getAssociation: AssociationRoleInterface::getAssociation() in AssociationRole.interface.php

getAssociation: Returns the association to which this association role belongs.
getAssociationRoles: AssociationInterface::getAssociationRoles() in Association.interface.php

getAssociationRoles: Returns the AssociationRoleInterface objects representing all of the roles in this association.
getAssociations: TopicMapInterface::getAssociations() in TopicMap.interface.php

getAssociations: Returns all of the associations in the topic map.
getBaseLocators: TopicMapSystemInterface::getBaseLocators() in TopicMapSystem.interface.php

getBaseLocators: Returns the base locators of the topic maps managed by the system.
getCause: TMAPIRuntimeException::getCause() in TMAPIRuntimeException.exception.php

getCause: Returns the cause of this exception or null if the cause is nonexistent or unknown.
getCause: TMAPIException::getCause() in TMAPIException.exception.php

getCause: Returns the cause of this exception or null if the cause is nonexistent or unknown.
getDatatype: VariantInterface::getDatatype() in Variant.interface.php

getDatatype: Returns the datatype of the variant's resource data.
getDatatype: OccurrenceInterface::getDatatype() in Occurrence.interface.php

getDatatype: Returns the datatype of the occurrence's resource data.
getFeature: TopicMapSystemInterface::getFeature() in TopicMapSystem.interface.php

getFeature: Returns the value of the feature specified by $featureName for this TopicMapSystemInterface instance.
getFeature: TopicMapSystemFactory::getFeature() in TopicMapSystemFactory.abstract.php

Returns the particular feature requested for in the underlying implementation of TopicMapSystemInterface.
getHelperObject: TopicMapInterface::getHelperObject() in TopicMap.interface.php

getHelperObject: Returns a helper object.
getItemidentifier: DuplicateItemidentifierException::getItemidentifier() in DuplicateItemIdentifierException.exception.php

getItemidentifier: Returns the duplicate item identifier.
getItemIdentifiers: TopicMapObjectInterface::getItemIdentifiers() in TopicMapObject.interface.php

getItemIdentifiers: Returns the array of item identifiers for this object.
getModifiedObject: ModelConstraintException::getModifiedObject() in ModelConstraintException.exception.php

getModifiedObject: Returns the object that was tried to modify.
getModifiedObject: DuplicateItemidentifierException::getModifiedObject() in DuplicateItemIdentifierException.exception.php

getModifiedObject: Returns the object that was tried to modify.
getModifiedTopic: TopicsMustMergeException::getModifiedTopic() in TopicsMustMergeException.exception.php

getModifiedTopic: Returns the topic which was changed in the operation that raised this exception.
getObjectById: TopicMapInterface::getObjectById() in TopicMap.interface.php

getObjectById: Returns the TopicMapObjectInterface managed by this topic map with the specified object ID.
getObjectByItemIdentifier: TopicMapInterface::getObjectByItemIdentifier() in TopicMap.interface.php

getObjectByItemIdentifier: Returns a TopicMapObjectInterface that is identified by the named item identifier.
getObjectId: TopicMapObjectInterface::getObjectId() in TopicMapObject.interface.php

Returns a topic map-specific identifier for this object.
getOccurrences: TopicInterface::getOccurrences() in Topic.interface.php

getOccurrences: Returns the occurrences defined for this topic.
getParent: TopicMapObjectInterface::getParent() in TopicMapObject.interface.php

getParent: Gets the parent object of a TopicMapObjectInterface.
getPlayer: AssociationRoleInterface::getPlayer() in AssociationRole.interface.php

getPlayer: Returns the player of this association role or null if there is no role player.
getProperty: TopicMapSystemFactory::getProperty() in TopicMapSystemFactory.abstract.php

Gets the value of a property in the underlying implementation of TopicMapSystemInterface.
getProperty: TopicMapSystemInterface::getProperty() in TopicMapSystem.interface.php

getProperty: Gets a property in the underlying implementation of TopicMapSystemInterface.
getReified: TopicInterface::getReified() in Topic.interface.php

getReified: Returns an array of TopicMapObjectInterface instances that are subject of this topic.
getReifier: AssociationRoleInterface::getReifier() in AssociationRole.interface.php

getReifier: Returns the topic that reifies this association role.
getReifier: TopicNameInterface::getReifier() in TopicName.interface.php

getReifier: Returns the topic that reifies this topic name.
getReifier: AssociationInterface::getReifier() in Association.interface.php

getReifier: Returns the TopicInterface that reifies this association.
getReifier: VariantInterface::getReifier() in Variant.interface.php

getReifier: Returns the topic that reifies this variant name.
getReifier: OccurrenceInterface::getReifier() in Occurrence.interface.php

getReifier: Returns the topic that reifies this occurrence.
getReifier: TopicMapInterface::getReifier() in TopicMap.interface.php

getReifier: Returns the topic that reifies this topic map.
getRolesPlayed: TopicInterface::getRolesPlayed() in Topic.interface.php

Returns the association roles in which this topic is a player.
getScope: ScopedObjectInterface::getScope() in ScopedObject.interface.php

getScope: Returns the topics which define the scope/parameters of this ScopedObjectInterface.
getSubjectIdentifiers: TopicInterface::getSubjectIdentifiers() in Topic.interface.php

getSubjectIdentifiers: Returns the locators which reference the subject-indicating resources of this topic.
getSubjectLocators: TopicInterface::getSubjectLocators() in Topic.interface.php

getSubjectLocators: Returns locators which reference the subject-constituting resources of this topic.
getTopic: TopicNameInterface::getTopic() in TopicName.interface.php

getTopic: Returns the topic which contains this topic name.
getTopic: OccurrenceInterface::getTopic() in Occurrence.interface.php

getTopic: Returns the topic to which this occurrence belongs.
getTopicBySubjectIdentifier: TopicMapInterface::getTopicBySubjectIdentifier() in TopicMap.interface.php

getTopicBySubjectIdentifier: Returns the topic whose subject is identified by the named identifier that must be a URI.
getTopicBySubjectLocator: TopicMapInterface::getTopicBySubjectLocator() in TopicMap.interface.php

getTopicBySubjectLocator: Returns the topic whose subject is represented by the named locator.
getTopicMap: TopicMapSystemInterface::getTopicMap() in TopicMapSystem.interface.php

getTopicMap: Retrieves the topic map managed by the system with the specified base locator.
getTopicMap: TopicMapObjectInterface::getTopicMap() in TopicMapObject.interface.php

getTopicMap: Returns the topic map to which this object belongs.
getTopicMapSystem: TopicMapInterface::getTopicMapSystem() in TopicMap.interface.php

getTopicMapSystem: Returns the topic map system to which this topic map belongs.
getTopicName: VariantInterface::getTopicName() in Variant.interface.php

getTopicName: Returns the topic name to which this variant belongs.
getTopicNames: TopicInterface::getTopicNames() in Topic.interface.php

getTopicNames: Returns the topic names defined for this topic.
getTopics: SubjectLocatorClashException::getTopics() in SubjectLocatorClashException.exception.php

getTopics: Returns the topics involved in the clash of subjectLocator property values.
getTopics: TopicMapInterface::getTopics() in TopicMap.interface.php

getTopics: Returns all of the topics in the topic map.
getType: TypedObjectInterface::getType() in TypedObject.interface.php

getType: Returns the type of the object
getTypes: TopicInterface::getTypes() in Topic.interface.php

Returns the topics which define the types of this topic.
getUnmodifiedObject: DuplicateItemidentifierException::getUnmodifiedObject() in DuplicateItemIdentifierException.exception.php

getUnmodifiedObject: Returns the object that was not modified.
getUnmodifiedTopic: TopicsMustMergeException::getUnmodifiedTopic() in TopicsMustMergeException.exception.php

getUnmodifiedTopic: Returns the topic which was unchanged in the operation that raised this exception.
getValue: VariantInterface::getValue() in Variant.interface.php

getValue: Returns the data string associated with this variant.
getValue: OccurrenceInterface::getValue() in Occurrence.interface.php

getValue: Returns the data string associated with this occurrence.
getValue: TopicNameInterface::getValue() in TopicName.interface.php

getValue: Returns the name string of the topic name.
getVariants: TopicNameInterface::getVariants() in TopicName.interface.php

getVariants: Returns the VariantInterface instances defined for this topic name.

top

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

Returns if the particular feature is supported by the TopicMapSystemInterface.
HelperObjectConfigurationException: HelperObjectConfigurationException in HelperObjectConfigurationException.exception.php

public class HelperObjectConfigurationException: Exception raised when the configuration of a TopicMapSystemConfigurableHelperObjectInterface instance fails.
HelperObjectInstantiationException: HelperObjectInstantiationException in HelperObjectInstantiationException.exception.php

public class HelperObjectInstantiationException: Exception raised when the instantiation of a helper object fails.
HelperObjectConfigurationException.exception.php: HelperObjectConfigurationException.exception.php in HelperObjectConfigurationException.exception.php
HelperObjectInstantiationException.exception.php: HelperObjectInstantiationException.exception.php in HelperObjectInstantiationException.exception.php

top

MergeException: MergeException in MergeException.exception.php

public class MergeException: The base class for exceptions related to merging of topic or topic map instances.
mergeIn: TopicInterface::mergeIn() in Topic.interface.php

mergeIn: Merges another topic into this topic.
mergeIn: TopicMapInterface::mergeIn() in TopicMap.interface.php

mergeIn: Merges the topic map $othermap into this topic map.
ModelConstraintException: ModelConstraintException in ModelConstraintException.exception.php

public class ModelConstraintException: Exception thrown when an attempt is made to modify a TopicMapObjectInterface in a way which violates a constraint of the currently enabled processor model.
MergeException.exception.php: MergeException.exception.php in MergeException.exception.php
ModelConstraintException.exception.php: ModelConstraintException.exception.php in ModelConstraintException.exception.php

top

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

newInstance: This static method creates a new factory instance.
newTopicMapSystem: TopicMapSystemFactory::newTopicMapSystem() in TopicMapSystemFactory.abstract.php

newTopicMapSystem: Creates a new TopicMapSystemInterface instance using the currently configured factory parameters.

top

OccurrenceInterface: OccurrenceInterface in Occurrence.interface.php

Interface OccurrenceInterface: Represents the topic map occurrence construct.
Occurrence.interface.php: Occurrence.interface.php in Occurrence.interface.php

top

remove: TopicMapObjectInterface::remove() in TopicMapObject.interface.php

remove: Removes the object.
removeItemIdentifier: TopicMapObjectInterface::removeItemIdentifier() in TopicMapObject.interface.php

removeItemIdentifiers: Removes a locator from the set of item identifiers for this object.
removeScopingTopic: ScopedObjectInterface::removeScopingTopic() in ScopedObject.interface.php

removeScopingTopic: Removes a topic which defines the scope/parameters for this ScopedObjectInterface.
removeSubjectIdentifier: TopicInterface::removeSubjectIdentifier() in Topic.interface.php

removeSubjectIdentifier: Removes the specified locator from the set of locators that reference the subject-indicating resources of this topic.
removeSubjectLocator: TopicInterface::removeSubjectLocator() in Topic.interface.php

removeSubjectLocator: Removes the specified locator from the set of locators that reference the subject-constituting resources of this topic.
removeType: TopicInterface::removeType() in Topic.interface.php

removeType: Removes a type from this topic.

top

ScopedObject.interface.php: ScopedObject.interface.php in ScopedObject.interface.php
SubjectLocatorClashException.exception.php: SubjectLocatorClashException.exception.php in SubjectLocatorClashException.exception.php
ScopedObjectInterface: ScopedObjectInterface in ScopedObject.interface.php

Interface ScopedObjectInterface: The base class for all objects which define a scope or parameter property.
setFeature: TopicMapSystemFactory::setFeature() in TopicMapSystemFactory.abstract.php

setFeature: Sets a particular feature in the underlying implementation of TopicMapSystemInterface.
setPlayer: AssociationRoleInterface::setPlayer() in AssociationRole.interface.php

setPlayer: Sets the player of this association role.
setProperties: TopicMapSystemFactory::setProperties() in TopicMapSystemFactory.abstract.php

Sets the properties in the underlying implementation of TopicMapSystemInterface.
setProperty: TopicMapSystemFactory::setProperty() in TopicMapSystemFactory.abstract.php

Sets a property in the underlying implementation of TopicMapSystemInterface.
setReifier: VariantInterface::setReifier() in Variant.interface.php

setReifier: Sets the reifiying topic of this variant name.
setReifier: TopicNameInterface::setReifier() in TopicName.interface.php

setReifier: Sets the reifiying topic of this topic name.
setReifier: AssociationInterface::setReifier() in Association.interface.php

setReifier: Sets the reifiying topic of this association.
setReifier: AssociationRoleInterface::setReifier() in AssociationRole.interface.php

setReifier: Sets the reifiying topic of this association role.
setReifier: TopicMapInterface::setReifier() in TopicMap.interface.php

setReifier: Sets the reifiying topic of this topic map.
setReifier: OccurrenceInterface::setReifier() in Occurrence.interface.php

setReifier: Sets the reifiying topic of this variant name.
setType: TypedObjectInterface::setType() in TypedObject.interface.php

setType: Sets the type of the object.
setValue: VariantInterface::setValue() in Variant.interface.php

setValue: Sets the resource data string for this variant.
setValue: TopicNameInterface::setValue() in TopicName.interface.php

setValue: Define the name string for this topic name.
setValue: OccurrenceInterface::setValue() in Occurrence.interface.php

setValue: Sets the value data string for this occurrence.
SubjectLocatorClashException: SubjectLocatorClashException in SubjectLocatorClashException.exception.php

public class SubjectLocatorClashException: Thrown when two topics cannot be merged because the XTM 1.

top

TMAPIException.exception.php: TMAPIException.exception.php in TMAPIException.exception.php
TMAPIRuntimeException.exception.php: TMAPIRuntimeException.exception.php in TMAPIRuntimeException.exception.php
TopicInUseException.exception.php: TopicInUseException.exception.php in TopicInUseException.exception.php
TopicMapExistsException.exception.php: TopicMapExistsException.exception.php in TopicMapExistsException.exception.php
TopicMapObject.interface.php: TopicMapObject.interface.php in TopicMapObject.interface.php
TopicMapSystemFactory.abstract.php: TopicMapSystemFactory.abstract.php in TopicMapSystemFactory.abstract.php
TopicMapSystem.ConfigurableHelperObject.interface.php: TopicMapSystem.ConfigurableHelperObject.interface.php in TopicMapSystem.ConfigurableHelperObject.interface.php
TopicMapSystem.interface.php: TopicMapSystem.interface.php in TopicMapSystem.interface.php
TopicMap.interface.php: TopicMap.interface.php in TopicMap.interface.php
TopicName.interface.php: TopicName.interface.php in TopicName.interface.php
TopicsMustMergeException.exception.php: TopicsMustMergeException.exception.php in TopicsMustMergeException.exception.php
Topic.interface.php: Topic.interface.php in Topic.interface.php
TypedObject.interface.php: TypedObject.interface.php in TypedObject.interface.php
TMAPIException: TMAPIException in TMAPIException.exception.php

public class TMAPIException: The base class for all standard (non run-time) exceptions thrown by a PHPTMAPI system.
TMAPIRuntimeException: TMAPIRuntimeException in TMAPIRuntimeException.exception.php

public class TMAPIRuntimeException: 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 by a TopicMapObjectInterface.
TopicInterface: TopicInterface in Topic.interface.php

Interface TopicInterface: Represents the topic map topic construct.
TopicInUseException: TopicInUseException in TopicInUseException.exception.php

public class TopicInUseException: Thrown when an attempt is made to remove a topic which is being used as a type or as a role player in an association, or in a scope.
TopicMapExistsException: TopicMapExistsException in TopicMapExistsException.exception.php

public class TopicMapExistsException: Exception thrown when an attempt is made to create a new topic map with a base locator that is already assigned to another topic map in the same topic map system.
TopicMapInterface: TopicMapInterface in TopicMap.interface.php

Interface TopicMapInterface: Represents a topic map construct.
TopicMapObjectInterface: TopicMapObjectInterface in TopicMapObject.interface.php

Interface TopicMapObjectInterface: The base class for all objects in the PHPTMAPI system which represent constructs in a topic map.
TopicMapSystemConfigurableHelperObjectInterface: TopicMapSystemConfigurableHelperObjectInterface in TopicMapSystem.ConfigurableHelperObject.interface.php

Interface TopicMapSystemConfigurableHelperObjectInterface: An interface for a helper object implementation which requires notification of the TopicMapInterface instance it acts upon.
TopicMapSystemFactory: TopicMapSystemFactory in TopicMapSystemFactory.abstract.php

abstract class TopicMapSystemFactory: This factory class provides access to a topic map system.
TopicMapSystemInterface: TopicMapSystemInterface in TopicMapSystem.interface.php

Interface TopicMapSystemInterface: A generic interface to a PHPTMAPI system.
TopicNameInterface: TopicNameInterface in TopicName.interface.php

Interface TopicNameInterface: Represents the topic map topicname construct.
TopicsMustMergeException: TopicsMustMergeException in TopicsMustMergeException.exception.php

public class TopicsMustMergeException: Exception raised when a topic is changed in such a way that it would have to be merged with another topic in the same topic map.
TypedObjectInterface: TypedObjectInterface in TypedObject.interface.php

Interface TypedObjectInterface: Provides basic methods setType() and getType().

top

UnsupportedHelperObjectException.exception.php: UnsupportedHelperObjectException.exception.php in UnsupportedHelperObjectException.exception.php
UnsupportedOperationException.exception.php: UnsupportedOperationException.exception.php in UnsupportedOperationException.exception.php
UnsupportedHelperObjectException: UnsupportedHelperObjectException in UnsupportedHelperObjectException.exception.php

public class UnsupportedHelperObjectException: Exception raised when no implementation class is specified for a requested helper object interface.
UnsupportedOperationException: UnsupportedOperationException in UnsupportedOperationException.exception.php

public class UnsupportedOperationException: Thrown if the processor does not support the XTM 1.

top

Variant.interface.php: Variant.interface.php in Variant.interface.php
VariantInterface: VariantInterface in Variant.interface.php

Interface VariantInterface: Represents the topic map variant name construct.