Source for file Index.interface.php

Documentation is available at Index.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index
  4. */
  5. require_once('../org.phptmapi.core/TopicMapSystem.ConfigurableHelperObject.interface.php');
  6. /**
  7. * Interface IndexInterface: Abstract representation of a topic map index. This is the base interface that must be implemented by all indexes.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface IndexInterface extends TopicMapSystemConfigurableHelperObjectInterface{
  12. /**
  13. * close: Close the index.
  14. * @access public
  15. * @return void
  16. * @throws TMAPIIndexException()
  17. * <code>
  18. * public function close(){
  19. * throw new TMAPIIndexException('Exception in '.__method__);
  20. * }
  21. * </code>
  22. */
  23. public function close();
  24. /**
  25. * getFlags: Retrieve the IndexInterface instance that represents the static meta data for this index.
  26. * @access public
  27. * @return object IndexInterface
  28. * @throws TMAPIIndexException()
  29. * <code>
  30. * public function getFlags(){
  31. * throw new TMAPIIndexException('Exception in '.__method__);
  32. * }
  33. * </code>
  34. */
  35. public function getFlags();
  36. /**
  37. * isOpen: Return the state of this index. True if the index is currently open, false otherwise.
  38. * @access public
  39. * @return boolean
  40. * @throws TMAPIIndexException()
  41. * <code>
  42. * public function isOpen(){
  43. * throw new TMAPIIndexException('Exception in '.__method__);
  44. * }
  45. * </code>
  46. */
  47. public function isOpen();
  48. /**
  49. * open: Open the index. This method must be invoked before using any other method exported by this interface or derived interfaces.
  50. * @access public
  51. * @return void
  52. * @throws TMAPIIndexException()
  53. * <code>
  54. * public function open(){
  55. * throw new TMAPIIndexException('Exception in '.__method__);
  56. * }
  57. * </code>
  58. */
  59. public function open();
  60. /**
  61. * reindex: Resynchronize this index with the data in the topic map.
  62. * @access public
  63. * @return void
  64. * @throws TMAPIIndexException()
  65. * <code>
  66. * public function reindex(){
  67. * throw new TMAPIIndexException('Exception in '.__method__);
  68. * }
  69. * </code>
  70. */
  71. public function reindex();
  72. /**
  73. * isAutoUpdated: Returns the auto-update flag for the index. If the value of this flag is true, then the index is automatically kept synchronized with the topic map as values are changed. If the value is false, then the Index->reindex() method must be called to resynchronize the index with the topic map after values are changed.
  74. * @access public
  75. * @return boolean
  76. */
  77. public function isAutoUpdated();
  78. }
  79. ?>

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