Source for file OccurrencesIndex.interface.php

Documentation is available at OccurrencesIndex.interface.php

  1. <?PHP
  2. /**
  3. * @package org.phptmapi.index.core
  4. */
  5. require_once('../org.phptmapi.index/Index.interface.php');
  6. /**
  7. * Interface OccurrencesIndexInterface: An index of all OccurrenceInterface instances in the topic map by their type and resource reference or resource data.
  8. *
  9. * @author Johannes Schmidt - t8d <kontakt@t8d.de>
  10. */
  11. interface OccurrencesIndexInterface extends IndexInterface{
  12. /**
  13. * getOccurrences: Returns the occurrences in the topic map whose data matches $value and XML Schema datatype matches $datatype. The return value may be an empty array but must never be null.
  14. * @param string $value The occurrence data.
  15. * @param string $datatype An XML Schema Datatype.
  16. * @access public
  17. * @return array An array of OccurrenceInterface instances.
  18. */
  19. public function getOccurrences($value, $datatype);
  20. /**
  21. * getOccurrencesByType: Returns the occurrences typed by the topic type.
  22. * @param object TopicInterface $type The type of occurrences to be returned. If $type is null an array containing all untyped occurrences will be returned. The return value may be an empty array but must never be null.
  23. * @access public
  24. * @return array An array of OccurrenceInterface instances.
  25. */
  26. public function getOccurrencesByType($type);
  27. /**
  28. * getOccurrenceTypes: Returns the topics which are used to type occurrences in the indexed topic map. The return value may be an empty array but must never be null.
  29. * @access public
  30. * @return array An array of OccurrenceInterface instances.
  31. */
  32. public function getOccurrenceTypes();
  33. }
  34. ?>

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