|
|||||||||
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.DataSet
public class DataSet
A class that provides uniform access to data set metadata (from the openBIS AS) and data (from the openBIS DSS).
Constructor Summary | |
---|---|
DataSet(IOpenbisServiceFacade facade,
IDssComponent dssComponent,
DataSet metadata,
IDataSetDss dataSetDss)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
java.util.List<java.lang.String> |
getChildrenCodes()
|
java.lang.String |
getCode()
|
java.util.List<DataSet> |
getContainedDataSets()
|
DataSet |
getContainerOrNull()
|
IDataSetDss |
getDataSetDss()
Internal accessor, made public for testing, but clients should not need it. |
java.lang.String |
getDataSetTypeCode()
|
java.lang.String |
getExperimentIdentifier()
|
ch.systemsx.cisd.openbis.generic.shared.basic.dto.ExternalDataManagementSystem |
getExternalDataManagementSystem()
|
java.lang.String |
getExternalDataSetCode()
|
java.lang.String |
getExternalDataSetLink()
|
java.io.InputStream |
getFile(java.lang.String path)
|
java.io.File |
getLinkOrCopyOfContent(java.lang.String overrideStoreRootPathOrNull,
java.io.File downloadDir,
java.lang.String pathInDataSet)
|
java.io.File |
getLinkOrCopyOfContents(java.lang.String overrideStoreRootPathOrNull,
java.io.File downloadDir)
|
java.util.List<java.lang.String> |
getParentCodes()
|
DataSet |
getPrimaryDataSetOrNull()
Returns the primary data set. |
java.util.HashMap<java.lang.String,java.lang.String> |
getProperties()
|
java.util.Date |
getRegistrationDate()
|
java.util.EnumSet<DataSet.Connections> |
getRetrievedConnections()
|
java.lang.String |
getSampleIdentifierOrNull()
|
java.lang.String |
getSessionURLForFile(java.lang.String path)
|
java.lang.String |
getURLForFileWithTimeout(java.lang.String path,
long validityDurationInSeconds)
|
int |
hashCode()
|
boolean |
isContainerDataSet()
|
boolean |
isLinkDataSet()
|
boolean |
knowsContainer()
Returns true , if result of getContainerOrNull() can be trusted and
false , if it cannot be trusted because the server is too old to deliver this
information. |
FileInfoDssDTO[] |
listFiles(java.lang.String startPath,
boolean isRecursive)
|
java.lang.String |
toString()
|
java.io.File |
tryLinkToContents(java.lang.String overrideStoreRootPathOrNull)
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DataSet(IOpenbisServiceFacade facade, IDssComponent dssComponent, DataSet metadata, IDataSetDss dataSetDss)
facade
- The facade used to get access to the server.metadata
- The metadata. May be null if not available at construction time.dataSetDss
- The data. May be null if not available at construction time.Method Detail |
---|
public java.lang.String getCode()
DataSet.getCode()
public java.lang.String getExperimentIdentifier()
DataSet.getExperimentIdentifier()
public java.lang.String getSampleIdentifierOrNull()
DataSet.getSampleIdentifierOrNull()
public java.lang.String getDataSetTypeCode()
DataSet.getDataSetTypeCode()
public java.util.Date getRegistrationDate()
DataSet.getRegistrationDate()
public java.util.HashMap<java.lang.String,java.lang.String> getProperties()
DataSet.getProperties()
public java.util.EnumSet<DataSet.Connections> getRetrievedConnections()
DataSet.getRetrievedConnections()
public java.util.List<java.lang.String> getParentCodes()
DataSet.getParentCodes()
public java.util.List<java.lang.String> getChildrenCodes()
DataSet.getChildrenCodes()
public boolean isContainerDataSet()
DataSet.isContainerDataSet()
public boolean isLinkDataSet()
DataSet.isLinkDataSet()
public java.lang.String getExternalDataSetCode()
DataSet.getExternalDataSetCode()
public java.lang.String getExternalDataSetLink()
DataSet.getExternalDataSetLink()
public ch.systemsx.cisd.openbis.generic.shared.basic.dto.ExternalDataManagementSystem getExternalDataManagementSystem()
DataSet.getExternalDataManagementSystem()
public DataSet getContainerOrNull()
DataSet.getContainerOrNull()
public boolean knowsContainer()
true
, if result of getContainerOrNull()
can be trusted and
false
, if it cannot be trusted because the server is too old to deliver this
information.
public java.util.List<DataSet> getContainedDataSets()
DataSet.getContainedDataSets()
public DataSet getPrimaryDataSetOrNull()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
DataSet.equals(java.lang.Object)
public int hashCode()
hashCode
in class java.lang.Object
DataSet.hashCode()
public java.lang.String toString()
toString
in class java.lang.Object
DataSet.toString()
public FileInfoDssDTO[] listFiles(java.lang.String startPath, boolean isRecursive) throws java.lang.IllegalArgumentException, InvalidSessionException
startPath
- isRecursive
-
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.listFiles(java.lang.String,
boolean)
public java.io.InputStream getFile(java.lang.String path) throws java.lang.IllegalArgumentException, InvalidSessionException
path
-
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.getFile(java.lang.String)
public java.io.File tryLinkToContents(java.lang.String overrideStoreRootPathOrNull) throws java.lang.IllegalArgumentException, InvalidSessionException
overrideStoreRootPathOrNull
-
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.tryLinkToContents(java.lang.String)
public java.io.File getLinkOrCopyOfContents(java.lang.String overrideStoreRootPathOrNull, java.io.File downloadDir) throws java.lang.IllegalArgumentException, InvalidSessionException
overrideStoreRootPathOrNull
- downloadDir
-
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.getLinkOrCopyOfContents(java.lang.String,
java.io.File)
public java.io.File getLinkOrCopyOfContent(java.lang.String overrideStoreRootPathOrNull, java.io.File downloadDir, java.lang.String pathInDataSet) throws java.lang.IllegalArgumentException, InvalidSessionException
overrideStoreRootPathOrNull
- downloadDir
- pathInDataSet
-
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.getLinkOrCopyOfContent(java.lang.String,
java.io.File, java.lang.String)
public java.lang.String getSessionURLForFile(java.lang.String path) throws java.lang.IllegalArgumentException, InvalidSessionException
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.getSessionURLForFile(java.lang.String)
public java.lang.String getURLForFileWithTimeout(java.lang.String path, long validityDurationInSeconds) throws java.lang.IllegalArgumentException, InvalidSessionException
java.lang.IllegalArgumentException
InvalidSessionException
IDataSetDss.getURLForFileWithTimeout(String,
long)
public IDataSetDss getDataSetDss()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |