|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectch.systemsx.cisd.openbis.dss.client.api.v1.impl.DataSetDss
public class DataSetDss
Constructor Summary | |
---|---|
DataSetDss(java.lang.String code,
IDssServiceRpcGeneric service,
ch.systemsx.cisd.openbis.dss.client.api.v1.impl.AuthenticatedState parent)
|
Method Summary | |
---|---|
java.lang.String |
getCode()
The code of this data set. |
java.io.InputStream |
getFile(java.lang.String path)
Get an InputStream with contents of a file contained in this data set. |
java.io.File |
getLinkOrCopyOfContent(java.lang.String overrideStoreRootPathOrNull,
java.io.File downloadDir,
java.lang.String pathInDataSet)
Returns a File , if possible, that directly references some specified content of a
data set in the data store server. |
java.io.File |
getLinkOrCopyOfContents(java.lang.String overrideStoreRootPathOrNull,
java.io.File downloadDir)
Returns a File , if possible, that directly references the contents of a data set in
the data store server. |
ch.systemsx.cisd.openbis.dss.client.api.v1.impl.AuthenticatedState |
getParent()
|
IDssServiceRpcGeneric |
getService()
|
FileInfoDssDTO[] |
listFiles(java.lang.String startPath,
boolean isRecursive)
List files contained in this data set. |
java.lang.String |
toString()
|
java.io.File |
tryLinkToContents(java.lang.String overrideStoreRootPathOrNull)
Returns a File , if possible, that directly references the contents of a data set in
the data store server. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DataSetDss(java.lang.String code, IDssServiceRpcGeneric service, ch.systemsx.cisd.openbis.dss.client.api.v1.impl.AuthenticatedState parent)
Method Detail |
---|
public java.lang.String getCode()
IDataSetDss
getCode
in interface IDataSetDss
public java.io.InputStream getFile(java.lang.String path) throws java.lang.IllegalArgumentException, InvalidSessionException
IDataSetDss
InputStream
with contents of a file contained in this data set.
getFile
in interface IDataSetDss
path
- The path of the file to retrieve. The path must be relative with respect to the
data set, such as the path returned by FileInfoDssDTO.getPathInDataSet()
.
java.lang.IllegalArgumentException
InvalidSessionException
public FileInfoDssDTO[] listFiles(java.lang.String startPath, boolean isRecursive) throws java.lang.IllegalArgumentException, InvalidSessionException
IDataSetDss
listFiles
in interface IDataSetDss
startPath
- The path for the listing. The path must be relative with respect to the data
set, such as the path returned by FileInfoDssDTO.getPathInDataSet()
. Use "/"
or "" for the root of the hierarchy for this data set.isRecursive
- If true, the contents of any subdirectories will be listed as well.
java.lang.IllegalArgumentException
InvalidSessionException
public java.io.File tryLinkToContents(java.lang.String overrideStoreRootPathOrNull) throws java.lang.IllegalArgumentException, InvalidSessionException
IDataSetDss
File
, if possible, that directly references the contents of a data set in
the data store server. This is only possible if the file system used by the DSS is also
mounted locally.
tryLinkToContents
in interface IDataSetDss
overrideStoreRootPathOrNull
- A path, in the context of the local file system mounts, to
the DSS' store root. If null, paths are returned in the context of the DSS' file
system mounts.
java.lang.IllegalArgumentException
InvalidSessionException
public java.io.File getLinkOrCopyOfContents(java.lang.String overrideStoreRootPathOrNull, java.io.File downloadDir) throws java.lang.IllegalArgumentException, InvalidSessionException
IDataSetDss
File
, if possible, that directly references the contents of a data set in
the data store server. If not possible, downloads the data set contents and returns a File in
the downloadDir containing the contents of the data set.
getLinkOrCopyOfContents
in interface IDataSetDss
overrideStoreRootPathOrNull
- A path, in the context of the local file system mounts, to
the DSS' store root. If null, datasets are copied to the downloadDir folder.downloadDir
- The directory in which to place the contents of the data set if they must
be downloaded.
java.lang.IllegalArgumentException
InvalidSessionException
public java.io.File getLinkOrCopyOfContent(java.lang.String overrideStoreRootPathOrNull, java.io.File downloadDir, java.lang.String pathInDataSet) throws java.lang.IllegalArgumentException, InvalidSessionException
IDataSetDss
File
, if possible, that directly references some specified content of a
data set in the data store server. If not possible, downloads that content and returns a File
in the downloadDir containing that content.
getLinkOrCopyOfContent
in interface IDataSetDss
overrideStoreRootPathOrNull
- A path, in the context of the local file system mounts, to
the DSS' store root. If null, datasets are copied to the downloadDir folder.downloadDir
- The directory in which to place the contents of the data set if they must
be downloaded.pathInDataSet
- Path of requested content inside the data set.
java.lang.IllegalArgumentException
InvalidSessionException
public ch.systemsx.cisd.openbis.dss.client.api.v1.impl.AuthenticatedState getParent()
public IDssServiceRpcGeneric getService()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |