Docs For Class TopicInterface

Interface TopicInterface

Description

Interface TopicInterface: Represents the topic map topic construct.

author: Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>

Located in /org.phptmapi.core/Topic.interface.php (line 14)

TopicMapObjectInterface
   |
   --TopicInterface

Method Summary

void addSubjectIdentifier (string $subjectIdentifier)

void addSubjectLocator (string $subjectLocator)

void addType (TopicInterface $type)

object OccurrenceInterface createOccurrence (string $value, string $datatype, object TopicInterface $type, array $scope)

object TopicNameInterface createTopicName (string $value, object TopicInterface $type, array $scope)

object TopicNameInterface createUntypedTopicName (string $value, array $scope)

array getOccurrences ()

array getReified ()

array getRolesPlayed ()

array getSubjectIdentifiers ()

array getSubjectLocators ()

array getTopicNames ()

array getTypes ()

void mergeIn (TopicInterface $other)

void removeSubjectIdentifier (string $subjectIdentifier)

void removeSubjectLocator (string $subjectLocator)

void removeType (TopicInterface $type)

Methods

addSubjectIdentifier (line 162)

addSubjectIdentifier: Adds the specified locator to the locators that reference the subject-indicating resources of this topic.

access: public

throws: MergeException if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.

     public function addSubjectIdentifier($subjectIdentifier){
        throw new MergeException('Exception in '.__method__);
     }

void addSubjectIdentifier (string $subjectIdentifier)

string $subjectIdentifier

addSubjectLocator (line 29)

addSubjectLocator: Adds the specified locator to the locators that reference the subject-constituting resources of this topic.

access: public
throws: ModelConstraintException - if the XTM 1.0 processor model is enabled and this Topic already has one Locator in the subjectLocator set.

throws: MergeException - if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.

     public function addSubjectLocator($subjectLocator){
        throw new ModelConstraintException('Exception in '.__method__);
         throw new MergeException('Exception in '.__method__);
     }

void addSubjectLocator (string $subjectLocator)

string $subjectLocator

addType (line 37)

addType: Adds a type to this topic.

access: public

void addType (TopicInterface $type)

object TopicInterface $type: The type-defining topic to be added.

createOccurrence (line 48)

createOccurrence: Creates a new occurrence as a contained object in this topic.

access: public

object OccurrenceInterface createOccurrence (string $value, string $datatype, object TopicInterface $type, array $scope)

string $value: The occurrence data.
string $datatype: An XML Schema Datatype.
object TopicInterface $type: The occurrence type. If null, then the occurrence will be untyped.
array $scope: An array of TopicInterface objects. If null, the occurrence will be in the unconstrained scope.

createTopicName (line 83)

createTopicName: Creates a new typed topic name for this topic.

access: public
throws: MergeException - if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason.

throws: UnsupportedOperationException - if the processor does not support the XTM 1.1 model.

     public function createTopicName($value, $scope){
         throw new MergeException('Exception in '.__method__);
     }
     public function createTopicName($value, $scope){
         throw new UnsupportedOperationException('Exception in '.__method__);
     }

object TopicNameInterface createTopicName (string $value, object TopicInterface $type, array $scope)

string $value: The string value of the topic name. Pass null to create a topic name with no name value.
object TopicInterface $type: A TopicInterface instance or null.
array $scope: An array of TopicInterface objects. If null, the topic name will be in the unconstrained scope.

createUntypedTopicName (line 63)

createUntypedTopicName: Creates a new untyped name for this topic.

access: public

throws: MergeException - if the processor detects that a merge is required and either automerge is disabled or automerge is enabled but the merge cannot be completed for some other reason. NOTE: This method will not raise this exception if the XTM 1.1 model is enabled, as untyped names do not cause merging under XTM 1.1.

     public function createTopicName($value, $scope){
         throw new MergeException('Exception in '.__method__);
     }

object TopicNameInterface createUntypedTopicName (string $value, array $scope)

string $value: The string value of the topic name. Pass null to create a topic name with no name value.
array $scope: An array of TopicInterface objects. If null, the topic name will be in the unconstrained scope.

getOccurrences (line 90)

getOccurrences: Returns the occurrences defined for this topic.

getOccurrences: Returns the occurrences defined for this topic. The return value may be an empty array, but is never null.

return: An unmodifiable array of OccurrenceInterface objects.
access: public

array getOccurrences ()

getReified (line 97)

getReified: Returns an array of TopicMapObjectInterface instances that are subject of this topic.

getReified: Returns an array of TopicMapObjectInterface instances that are subject of this topic. The return value may be an empty array, but is never null.

access: public

array getReified ()

getRolesPlayed (line 104)

Returns the association roles in which this topic is a player.

Returns the association roles in which this topic is a player. The return value may be an empty array, but is never null.

return: An unmodifiable array of AssociationRoleInterface objects.
access: public

array getRolesPlayed ()

getSubjectIdentifiers (line 111)

getSubjectIdentifiers: Returns the locators which reference the subject-indicating resources of this topic.

getSubjectIdentifiers: Returns the locators which reference the subject-indicating resources of this topic. The return value may be an empty array, but is never null.

return: An unmodifiable array of locators.
access: public

array getSubjectIdentifiers ()

getSubjectLocators (line 118)

getSubjectLocators: Returns locators which reference the subject-constituting resources of this topic.

getSubjectLocators: Returns locators which reference the subject-constituting resources of this topic. The return value may be an empty array, but is never null.

return: An unmodifiable array of locators.
access: public

array getSubjectLocators ()

getTopicNames (line 125)

getTopicNames: Returns the topic names defined for this topic.

getTopicNames: Returns the topic names defined for this topic. The return value may be an empty array, but is never null.

return: An unmodifiable array of TopicNameInterface objects.
access: public

array getTopicNames ()

getTypes (line 132)

Returns the topics which define the types of this topic.

Returns the topics which define the types of this topic. The return value may be an empty array, but is never null.

return: An unmodifiable array of TopicInterface objects.
access: public

array getTypes ()

mergeIn (line 148)

mergeIn: Merges another topic into this topic.

mergeIn: Merges another topic into this topic. Merging a topic into this topic causes this topic to gain all of the characteristics of the other topic and to replace the other topic wherever it is used as a typing or scoping topic. After this method completes, other will have been removed from the topic map. NOTE: The other topic MUST belong to the same topic map instance as this topic!

access: public
throws: MergeException

throws: SubjectLocatorClashException if this topic and other have different, non-null values for the subject locator property and the XTM 1.0 processing model is enabled.

    public function mergeIn(TopicInterface $other){
        throw new MergeException('Exception in '.__method__);
         throw new SubjectLocatorClashException('Exception in '.__method__);
    }

void mergeIn (TopicInterface $other)

object TopicInterface $other

removeSubjectIdentifier (line 170)

removeSubjectIdentifier: Removes the specified locator from the set of locators that reference the subject-indicating resources of this topic.

access: public

void removeSubjectIdentifier (string $subjectIdentifier)

string $subjectIdentifier

removeSubjectLocator (line 178)

removeSubjectLocator: Removes the specified locator from the set of locators that reference the subject-constituting resources of this topic.

access: public

void removeSubjectLocator (string $subjectLocator)

string $subjectLocator

removeType (line 186)

removeType: Removes a type from this topic.

access: public

void removeType (TopicInterface $type)

object TopicInterface $type

Inherited Methods

Inherited From TopicMapObjectInterface

TopicMapObjectInterface::addItemIdentifier()
TopicMapObjectInterface::getItemIdentifiers()
TopicMapObjectInterface::getObjectId()
TopicMapObjectInterface::getParent()
TopicMapObjectInterface::getTopicMap()
TopicMapObjectInterface::remove()
TopicMapObjectInterface::removeItemIdentifier()

Documentation generated on Fri, 30 Jun 2006 13:07:03 +0200 by phpDocumentor 1.3.0RC4