Source for file TopicMap.interface.php

Documentation is available at TopicMap.interface.php

  1. <?php
  2. /**
  3. * @package org.phptmapi.core
  4. */
  5. require_once('TopicMapObject.interface.php');
  6. /**
  7. * Interface TopicMapInterface: Represents a topic map construct.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface TopicMapInterface extends TopicMapObjectInterface{
  12. /**
  13. * close: Closes use of this topic map. This method should be invoked by the application once it is finished using the TopicMapInterface instance. Implementations may release any resources required for the TopicMapInterface instance or any of the TopicMapObjectInterface instances contained by the TopicMapInterface instance.
  14. * @access public
  15. * @return void
  16. */
  17. public function close();
  18. /**
  19. * createAssociation: Creates a new association in the topic map. The newly created association has no type, no roles and is in the unconstrained scope.
  20. * @access public
  21. * @return object AssociationInterface
  22. */
  23. public function createAssociation();
  24. /**
  25. * getAssociations: Returns all of the associations in the topic map. The return value may be an empty array, but is never null.
  26. * @access public
  27. * @return array
  28. */
  29. public function getAssociations();
  30. /**
  31. * getTopics: Returns all of the topics in the topic map. The return value may be an empty array, but is never null.
  32. * @access public
  33. * @return array
  34. */
  35. public function getTopics();
  36. /**
  37. * createTopic: Creates a new topic in the topic map. The newly created topic has no types, names or occurrences.
  38. * @access public
  39. * @return object TopicInterface
  40. */
  41. public function createTopic();
  42. /**
  43. * getObjectById: Returns the TopicMapObjectInterface managed by this topic map with the specified object ID.
  44. * @param string $objectId
  45. * @access public
  46. * @return object TopicMapObjectInterface
  47. */
  48. public function getObjectById($objectId);
  49.  
  50. /**
  51. * getReifier: Returns the topic that reifies this topic map.
  52. * @access public
  53. * @return object TopicInterface
  54. */
  55. public function getReifier();
  56. /**
  57. * setReifier: Sets the reifiying topic of this topic map.
  58. * @param object TopicInterface $reifier or null if the reifier should be set to null
  59. * @access public
  60. * @return void
  61. * @throws ModelConstraintException if the topic already reifies another object
  62. * <code>
  63. * public function setReifier($reifier){
  64. * throw new ModelConstraintException('Exception in '.__method__);
  65. * }
  66. * </code>
  67. */
  68. public function setReifier($reifier);
  69. /**
  70. * getTopicMapSystem: Returns the topic map system to which this topic map belongs.
  71. * @access public
  72. * @return object TopicMapSystemInterface
  73. */
  74. public function getTopicMapSystem();
  75. /**
  76. * mergeIn: Merges the topic map $othermap into this topic map. All topics and associations and all of their contents in other will be added to this topic map. Topics in other will be merged with topics in this topic map as defined by XTM merging rules. The merge process will not modify $othermap in any way.
  77. * @param object TopicMapInterface $othermap
  78. * @access public
  79. * @return void
  80. * @throws MergeException if merging of topics of this topic map instance and the other cannot be completed because of subject locator property conflicts and the XTM 1.0 processing model is enabled.
  81. * <code>
  82. * public function mergeIn(TopicMapInterface $othermap){
  83. * throw new MergeException('Exception in '.__method__);
  84. * }
  85. * </code>
  86. */
  87. public function mergeIn(TopicMapInterface $othermap);
  88. /**
  89. * getObjectByItemIdentifier: Returns a TopicMapObjectInterface that is identified by the named item identifier.
  90. * @param string $itemIdentifier
  91. * @access public
  92. * @return object TopicMapObjectInterface
  93. */
  94. public function getObjectByItemIdentifier($itemIdentifier);
  95. /**
  96. * getTopicBySubjectLocator: Returns the topic whose subject is represented by the named locator.
  97. * @param string $subjectLocator
  98. * @access public
  99. * @return object TopicInterface
  100. */
  101. public function getTopicBySubjectLocator($subjectLocator);
  102. /**
  103. * getTopicBySubjectIdentifier: Returns the topic whose subject is identified by the named identifier that must be a URI.
  104. * @param string $subjectIdentifier
  105. * @access public
  106. * @return object TopicInterface
  107. */
  108. public function getTopicBySubjectIdentifier($subjectIdentifier);
  109. /**
  110. * getHelperObject: Returns a helper object. The discovery procedure is similar as implemented in TopicMapSystemFactory using a discovery file in '../META/$implementationDirectoryName/$implementationClassName'. The "discovered" helper object is then assigned to an implementation of TopicMapSystemConfigurableHelperObjectInterface.
  111. * @param string $implementationDirectoryName
  112. * @param string $implementationClassName
  113. * @access public
  114. * @return object
  115. * @throws UnsupportedHelperObjectException if no implementation can be found.
  116. * @throws HelperObjectInstantiationException if the specified implementation class could not be loaded or if a new instance of the helper class could not be instantiated.
  117. * @throws HelperObjectConfigurationException if the TopicMapSystemConfigurableHelperObjectInterface->configure(TopicMapInterface $tm) method of the helper object implementation raises an exception.
  118. * <code>
  119. * public function getHelperObject($implementationClassName){
  120. * throw new UnsupportedHelperObjectException('Exception in '.__method__);
  121. * throw new HelperObjectInstantiationException('Exception in '.__method__);
  122. * throw new HelperObjectConfigurationException('Exception in '.__method__);
  123. * }
  124. * </code>
  125. */
  126. public function getHelperObject($implementationDirectoryName, $implementationClassName);
  127. }
  128. ?>

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