services

DatasetService

trait DatasetService extends AnyRef

Generic dataset service.

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

Abstract Value Members

  1. abstract def addCollection(datasetId: UUID, collectionId: UUID): Unit

  2. abstract def addCreator(id: UUID, creator: String): Unit

    Add a creator to the end of the dataset's list of creators

  3. abstract def addFile(datasetId: UUID, file: File): Unit

    Add file to dataset.

  4. abstract def addFolder(datasetId: UUID, folderId: UUID): Unit

    Add Folder to dataset.

  5. abstract def addFollower(id: UUID, userId: UUID): Unit

    Add follower to a dataset.

  6. abstract def addMetadata(id: UUID, json: String): Unit

  7. abstract def addTags(id: UUID, userIdStr: Option[String], eid: Option[String], tags: List[String]): Unit

  8. abstract def addToSpace(dataset: UUID, space: UUID): Unit

    Associate a dataset with a space

  9. abstract def addUserMetadata(id: UUID, json: String): Unit

  10. abstract def addXMLMetadata(id: UUID, fileId: UUID, json: String): Unit

  11. abstract def count(): Long

    The number of datasets

  12. abstract def countAccess(permisions: Set[Permission], user: Option[User], showAll: Boolean): Long

    Return a count of datasets the user has access to.

  13. abstract def countCollection(collection: String): Long

    Return a count of datasets in a collection, this does not check for permissions

  14. abstract def countSpace(space: String): Long

    Return a count of datasets in a space, this does not check for permissions

  15. abstract def countUser(user: Option[User], showAll: Boolean, owner: User): Long

    Return a count of datasets the user has created.

  16. abstract def createThumbnail(datasetId: UUID): Unit

    Set new thumbnail.

  17. abstract def dumpAllDatasetGroupings(): List[String]

  18. abstract def dumpAllDatasetMetadata(): List[String]

  19. abstract def findByFileIdAllContain(file_id: UUID): List[Dataset]

  20. abstract def findByFileIdDirectlyContain(file_id: UUID): List[Dataset]

  21. abstract def findByTag(tag: String, start: String, limit: Integer, reverse: Boolean, user: Option[User]): List[Dataset]

  22. abstract def findByTag(tag: String, user: Option[User]): List[Dataset]

  23. abstract def findMetadataChangedDatasets(): List[Dataset]

  24. abstract def findNotContainingFile(file_id: UUID): List[Dataset]

  25. abstract def findOneByFileId(file_id: UUID): Option[Dataset]

  26. abstract def get(ids: List[UUID]): DBResult[Dataset]

  27. abstract def get(id: UUID): Option[Dataset]

    Get dataset.

  28. abstract def getFileId(datasetId: UUID, filename: String): Option[UUID]

    Get the id of a file based on its filename and dataset it belongs to.

  29. abstract def getMetadata(id: UUID): Map[String, Any]

  30. abstract def getMetrics(user: Option[User]): Iterable[Dataset]

  31. abstract def getTags(user: Option[User]): Map[String, Long]

    Return a list of tags and counts found in sections

  32. abstract def getTechnicalMetadataJSON(id: UUID): String

  33. abstract def getUserMetadata(id: UUID): Map[String, Any]

  34. abstract def getUserMetadataJSON(id: UUID): String

  35. abstract def getXMLMetadataJSON(id: UUID): String

  36. abstract def incrementDownloads(id: UUID, user: Option[User]): Unit

  37. abstract def incrementMetadataCount(id: UUID, count: Long): Unit

    Change the metadataCount field for a dataset

  38. abstract def incrementViews(id: UUID, user: Option[User]): (Int, Date)

  39. abstract def index(id: UUID): Unit

  40. abstract def index(id: Option[UUID]): Unit

    Index dataset, if no id provided, index all datasets.

  41. abstract def insert(dataset: Dataset): Option[String]

    Insert dataset.

  42. abstract def isInCollection(datasetId: UUID, collectionId: UUID): Boolean

    Check if dataset belongs to a collection.

  43. abstract def isInCollection(dataset: Dataset, collection: Collection): Boolean

    Check if a dataset is in a specific collection.

  44. abstract def listAccess(date: String, nextPage: Boolean, limit: Integer, title: String, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean, exact: Boolean): List[Dataset]

    Return a list of datasets the user has access to starting at a specific date.

  45. abstract def listAccess(date: String, nextPage: Boolean, limit: Integer, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean): List[Dataset]

    Return a list of datasets the user has access to starting at a specific date.

  46. abstract def listAccess(limit: Integer, title: String, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean, exact: Boolean): List[Dataset]

    Return a list of datasets the user has access to.

  47. abstract def listAccess(limit: Integer, permisions: Set[Permission], user: Option[User], showAll: Boolean, showPublic: Boolean, showOnlyShared: Boolean): List[Dataset]

    Return a list of datasets the user has access to.

  48. abstract def listCollection(date: String, nextPage: Boolean, limit: Integer, collection: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a collection starting at a specific date

  49. abstract def listCollection(limit: Integer, collection: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a collection

  50. abstract def listCollection(collection: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a collection

  51. abstract def listCollection(date: String, nextPage: Boolean, limit: Integer, collection: String): List[Dataset]

    Return a list of datasets in a collection starting at a specific date, this does not check for permissions

  52. abstract def listCollection(limit: Integer, collection: String): List[Dataset]

    Return a list of datasets in a collection, this does not check for permissions

  53. abstract def listCollection(collection: String): List[Dataset]

    Return a list of datasets in a collection, this does not check for permissions

  54. abstract def listSpace(date: String, nextPage: Boolean, limit: Integer, space: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a space starting at a specific date

  55. abstract def listSpace(limit: Integer, space: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a space

  56. abstract def listSpace(date: String, nextPage: Boolean, limit: Integer, space: String): List[Dataset]

    Return a list of datasets in a space starting at a specific date, this does not check for permissions

  57. abstract def listSpace(limit: Integer, space: String): List[Dataset]

    Return a list of datasets in a space, this does not check for permissions

  58. abstract def listSpaceAccess(date: String, nextPage: Boolean, limit: Integer, title: String, permisions: Set[Permission], space: String, user: Option[User], showAll: Boolean, showPublic: Boolean): List[Dataset]

    Return a list of datasets in a space the user has access to starting at a specific date with specific title.

  59. abstract def listSpaceAccess(date: String, nextPage: Boolean, limit: Integer, permisions: Set[Permission], space: String, user: Option[User], showAll: Boolean, showPublic: Boolean): List[Dataset]

    Return a list of datasets in a space the user has access to starting at a specific date.

  60. abstract def listSpaceAccess(limit: Integer, title: String, permisions: Set[Permission], space: String, user: Option[User], showAll: Boolean, showPublic: Boolean): List[Dataset]

    Return a list of datasets in a space with specific title the user has access to.

  61. abstract def listSpaceAccess(limit: Integer, permisions: Set[Permission], space: String, user: Option[User], showAll: Boolean, showPublic: Boolean): List[Dataset]

    Return a list of datasets in a space the user has access to.

  62. abstract def listSpaceStatus(date: String, nextPage: Boolean, limit: Integer, space: String, status: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a space filtered by status

  63. abstract def listSpaceStatus(limit: Integer, space: String, status: String, user: Option[User]): List[Dataset]

    Return a list of datasets in a space filtered by status

  64. abstract def listSpaceStatus(limit: Integer, space: String, status: String): List[Dataset]

    Return a list of datasets in a space filtered by status, this does not check for permissions

  65. abstract def listUser(user: Option[User]): List[Dataset]

    Return a list of all the datasets the user can view or has created.

  66. abstract def listUser(date: String, nextPage: Boolean, limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[Dataset]

    Return a list of datasets the user has created starting at a specific date.

  67. abstract def listUser(limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[Dataset]

    Return a list of datasets the user has created.

  68. abstract def listUserTrash(user: Option[User], limit: Integer): List[Dataset]

  69. abstract def listUserTrash(date: String, nextPage: Boolean, limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[Dataset]

    Return a list of datasets the user has created starting at a specific date.

  70. abstract def listUserTrash(limit: Integer, user: Option[User], showAll: Boolean, owner: User): List[Dataset]

    Return a list of datasets the user has created in trash.

  71. abstract def modifyRDFOfMetadataChangedDatasets(): Unit

  72. abstract def modifyRDFUserMetadata(id: UUID, mappingNumber: String = "1"): Unit

  73. abstract def moveCreator(id: UUID, creator: String, position: Integer): Unit

    Move a creator to a new position in the dataset's list of creators

  74. abstract def newThumbnail(datasetId: UUID): Unit

  75. abstract def removeAllTags(id: UUID): Unit

  76. abstract def removeCollection(datasetId: UUID, collectionId: UUID): Unit

  77. abstract def removeCreator(id: UUID, creator: String): Unit

    Remove a creator from the dataset's list of creators

  78. abstract def removeDataset(id: UUID, host: String, apiKey: Option[String], user: Option[User]): Unit

  79. abstract def removeFile(datasetId: UUID, fileId: UUID): Unit

    Remove file from dataset.

  80. abstract def removeFolder(datasetId: UUID, folderId: UUID): Unit

    Remove folder from dataset.

  81. abstract def removeFollower(id: UUID, userId: UUID): Unit

    Remove follower from a dataset.

  82. abstract def removeFromSpace(dataset: UUID, space: UUID): Unit

    Remove association between dataset and space

  83. abstract def removeTag(id: UUID, tagId: UUID): Unit

  84. abstract def removeTags(id: UUID, userIdStr: Option[String], eid: Option[String], tags: List[String]): Unit

  85. abstract def removeXMLMetadata(id: UUID, fileId: UUID): Unit

  86. abstract def searchAllMetadataFormulateQuery(requestedMetadataQuery: Any): List[Dataset]

  87. abstract def searchMetadata(id: UUID, requestedMap: LinkedHashMap[String, Any], currentMap: Map[String, Any]): Boolean

    Check recursively whether a (sub)tree of a dataset's metadata matches a requested search subtree.

  88. abstract def searchMetadataFormulateQuery(requestedMap: LinkedHashMap[String, Any], root: String): com.mongodb.casbah.Imports.MongoDBObject

  89. abstract def searchUserMetadata(id: UUID, requestedMetadataQuery: Any): Boolean

    Check recursively whether a dataset's user-input metadata match a requested search tree.

  90. abstract def searchUserMetadataFormulateQuery(requestedMetadataQuery: Any): List[Dataset]

  91. abstract def selectNewThumbnailFromFiles(datasetId: UUID): Unit

  92. abstract def setUserMetadataWasModified(id: UUID, wasModified: Boolean): Unit

  93. abstract def update(dataset: Dataset): Unit

  94. abstract def updateAuthorFullName(userId: UUID, fullName: String): Unit

  95. abstract def updateDescription(id: UUID, description: String): Unit

  96. abstract def updateInformation(id: UUID, description: String, name: String): Unit

    Update the administrative information associated with the dataset.

    Update the administrative information associated with the dataset. This information includes the owner, the description, and the date created. Currently, only the description is editable. In the future, other items or new data may be added that will be editable.

    id: The id of the dataset description: A String that represents the updated information for the dataset description. name: A String that represents the updated name for this dataset.

  97. abstract def updateLicense(id: UUID, licenseType: String, rightsHolder: String, licenseText: String, licenseUrl: String, allowDownload: String): Unit

    Update the license data that is currently associated with the dataset.

    Update the license data that is currently associated with the dataset.

    id: The id of the dataset licenseType: A String representing the type of license rightsHolder: A String that is the free-text describing the owner of the license. Only required for certain license types licenseText: Text that describes what the license is licenseUrl: A reference to the license information allowDownload: true or false, to allow downloading of the file or dataset. Relevant only for certain license types

  98. abstract def updateName(id: UUID, name: String): Unit

  99. abstract def updateThumbnail(datasetId: UUID, thumbnailId: UUID): Unit

    Update thumbnail used to represent this dataset.

Concrete 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. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped