services

VersusPlugin

class VersusPlugin extends Plugin

Versus Plugin

Linear Supertypes
Plugin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. VersusPlugin
  2. Plugin
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VersusPlugin(application: Application)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def addToIndex(url: String, index: VersusIndex, fileType: String): Unit

    Adds this file to this index ONLY if mimetypes match.

    Adds this file to this index ONLY if mimetypes match. Calls Versus REST endpoint. url - url where the file can be found and downloaded from

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def buildIndex(indexId: UUID): Future[Response]

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createIndex(adapter: String, extractor: String, measure: String, indexer: String): Future[UUID]

    Sends a request Versus to create an index.

    Sends a request Versus to create an index. Returns id of the created index.

  11. val datasets: DatasetService

  12. def deleteAllIndexes(): Future[Response]

    Sends a request to delete all indexes in Versus

  13. def deleteIndex(indexId: UUID): Future[Response]

    Sends a request to Versus to delete an index based on its id If sectionIndex - delete entry from sectionIndexInfo db collection

  14. def enabled: Boolean

    Definition Classes
    Plugin
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. def extract(fileid: UUID)(implicit request: Request[Any]): Future[Response]

  18. val files: FileService

  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def getAdapters(): Future[Response]

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getExtractors(): Future[Response]

  23. def getFileSeachResult(result_id: UUID, file: File, result: VersusSimilarityResult): SearchResultFile

  24. def getIdFromVersusURL(url: String): String

    Helper method to get id of file/preview as returned in search results from versus.

    Helper method to get id of file/preview as returned in search results from versus. url - docID of the result, could be file or preview id - id of the file or preview, a substring of the url (docID)

  25. def getIndexers(): Future[Response]

  26. def getIndexes(): Future[Response]

  27. def getIndexesAsFutureList(): Future[List[VersusIndex]]

  28. def getIndexesForContentTypeAsFutureList(contentType: String): Future[List[VersusIndex]]

  29. def getIndexesForType(typeToSearch: String, sectionsSelected: List[String]): Future[List[VersusIndex]]

    From all existing Versus indexes, select a subset based on typeToSearch and (optionally) sectionsSelected.

    From all existing Versus indexes, select a subset based on typeToSearch and (optionally) sectionsSelected.

    If typeToSearch is... both - return all the indexes sectionsSome - return selected sections sectionsAll - return all sections images - return indexes of whole images

  30. def getMeasures(): Future[Response]

  31. def getPrevSearchResult(preview_id: UUID, prevName: String, result: VersusSimilarityResult): Option[SearchResultPreview]

  32. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  33. def index(url: String, fileType: String): Unit

    Goes through all exisitng indexes, only adds file to indexes of matching mime type.

    Goes through all exisitng indexes, only adds file to indexes of matching mime type. url - the url of the file/section/preview being indexed, where it can be downloaded from.

  34. def indexFile(fileId: UUID, fileType: String)(implicit request: Request[Any]): Unit

    Sends a request to Versus REST endpoint to index a file Sends request to indexes that (1)contain whole files (as opposed to sections) and (2)of matching fileType

  35. def indexPreview(previewId: UUID, fileType: String)(implicit request: Request[Any]): Unit

    Sends a request to Versus REST endpoint to index a preview

    Sends a request to Versus REST endpoint to index a preview

    • could be preview of video file - first frame of each shot of a video, e.g. produced by 'cinemetrics' extractor
    • could be a preview of still image file - e.g. produced by 'face' or 'census' extractor
  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  40. def onStart(): Unit

    Definition Classes
    VersusPlugin → Plugin
  41. def onStop(): Unit

    Definition Classes
    VersusPlugin → Plugin
  42. val previews: PreviewService

  43. val queries: MultimediaQueryService

  44. def queryIndex(inputFileURL: String, indexId: String): Future[List[PreviewFilesSearchResult]]

    Sends a search query to an index in Versus input: inputFileURL - URL string of the file to query against an index indexId - id of the index to search within

    Sends a search query to an index in Versus input: inputFileURL - URL string of the file to query against an index indexId - id of the index to search within

    returns: list of previews and files search results: search results will be sorted by proximity to the given image.

    Note the the image index might contain both "previews", i.e. video file previews(images extracted from a video file) and "files", i.e. in case of image searching - files that were "born as still images"

    The list of results will contain both "previews" and "files" sorted by their proximity to the given image.

    In case of non-image file types (e.g. pdf), only list of files will be returned.

  45. def queryIndexForExistingFile(inputFileId: UUID, indexId: String)(implicit request: Request[Any]): Future[List[PreviewFilesSearchResult]]

  46. def queryIndexForNewFile(newFileId: UUID, indexId: String)(implicit request: Request[Any]): Future[List[PreviewFilesSearchResult]]

  47. def queryIndexForURL(fileURL: String, indexId: String): Future[List[PreviewFilesSearchResult]]

  48. def queryIndexSorted(inputFileId: String, indexId: String)(implicit request: Request[Any]): Future[HashMap[String, Double]]

    Used to display resutls with weighted combined indexes.

    Used to display resutls with weighted combined indexes. For a given index and file, will query index and return results the results are reorganized as a hash map of (file url, proximity) touples. Note: might be reorganized in the future to use queryIndex method

  49. def removeFromIndexes(fileId: UUID): Unit

  50. val sectionIndexInfo: SectionIndexInfoService

  51. val sections: SectionService

  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  53. def toString(): String

    Definition Classes
    AnyRef → Any
  54. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped