|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nih.nci.caarray.domain.AbstractCaArrayObject
gov.nih.nci.caarray.domain.AbstractCaArrayEntity
gov.nih.nci.caarray.domain.file.CaArrayFile
@UniqueConstraint(fields={@UniqueConstraintField(name="name"),@UniqueConstraintField(name="project"),@UniqueConstraintField(name="uniqueNameProject")}, message="{caarrayfile.uniqueConstraint}") public class CaArrayFile
This class represents metadata about a file managed by caArray.
Field Summary |
---|
Fields inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayEntity |
---|
CAARRAY_LSID_AUTHORITY, CAARRAY_LSID_NAMESPACE |
Fields inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayObject |
---|
DEFAULT_BATCH_SIZE, DEFAULT_STRING_COLUMN_SIZE, LARGE_TEXT_FIELD_LENGTH |
Constructor Summary | |
---|---|
CaArrayFile()
Default blank constructor. |
|
CaArrayFile(CaArrayFile parent)
Creates a CaArrayFile with a parent. |
Method Summary | |
---|---|
void |
addChild(CaArrayFile child)
Adds a new child CaArrayFile. |
int |
compareTo(CaArrayFile o)
|
java.util.Set<CaArrayFile> |
getChildren()
|
long |
getCompressedSize()
|
java.net.URI |
getDataHandle()
|
FileStatus |
getFileStatus()
|
FileType |
getFileType()
|
java.lang.String |
getName()
Gets the name. |
CaArrayFile |
getParent()
|
long |
getPartialSize()
|
Project |
getProject()
|
java.lang.String |
getStatus()
|
java.lang.String |
getType()
|
long |
getUncompressedSize()
|
gov.nih.nci.caarray.validation.FileValidationResult |
getValidationResult()
|
boolean |
hasChildren()
Indicates if the CaArrayFile has children (child CaArrayFile's) or not. |
boolean |
isImportable()
Check whether this file is eligible to be imported. |
boolean |
isPartial()
|
boolean |
isUnparsedAndReimportable()
Check whether this is a file that was previously imported but not parsed, but now can be imported and parsed (due to a parsing FileHandler being implemented for it). |
boolean |
isValidatable()
Check whether this file is eligible to be validated. |
java.util.Collection<? extends gov.nih.nci.caarray.security.Protectable> |
relatedProtectables()
|
void |
removeChild(CaArrayFile child)
Removes a child CaArrayFile. |
void |
setCompressedSize(long compressedSize)
This method should generally not be called directly, as file size is calculated when data is written to the file. |
void |
setDataHandle(java.net.URI dataHandle)
|
void |
setFileStatus(FileStatus fileStatus)
|
void |
setFileType(FileType fileType)
|
void |
setName(java.lang.String name)
Sets the name. |
void |
setPartialSize(long partialSize)
|
void |
setProject(Project project)
|
void |
setType(java.lang.String type)
|
void |
setUncompressedSize(long uncompressedSize)
This method should generally not be called directly, as file size is calculated when data is written to the file. |
void |
setValidationResult(gov.nih.nci.caarray.validation.FileValidationResult validationResult)
|
java.lang.String |
toString()
|
Methods inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayEntity |
---|
getLsid, getLsidAuthority, getLsidNamespace, getLsidObjectId, setLsid, setLsid, setLsidForEntity |
Methods inherited from class gov.nih.nci.caarray.domain.AbstractCaArrayObject |
---|
equals, getCaBigId, getId, getPostLoadSecurityPolicies, getRemoteApiSecurityPolicies, hashCode, setCaBigId, setId |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.fiveamsolutions.nci.commons.data.persistent.PersistentObject |
---|
getId |
Constructor Detail |
---|
public CaArrayFile()
public CaArrayFile(CaArrayFile parent)
parent
- the parent file.Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the namepublic FileStatus getFileStatus()
public void setFileStatus(FileStatus fileStatus)
fileStatus
- the fileStatus to setpublic FileType getFileType()
public void setFileType(FileType fileType)
fileType
- the fileType to setpublic boolean hasChildren()
public Project getProject()
public void setProject(Project project)
project
- the project to setpublic CaArrayFile getParent()
public boolean isPartial()
public java.util.Set<CaArrayFile> getChildren()
public long getUncompressedSize()
public void setUncompressedSize(long uncompressedSize)
uncompressedSize
- the uncompressed size of the file, in bytespublic long getCompressedSize()
public void setCompressedSize(long compressedSize)
compressedSize
- the compressed size of the file, in bytespublic long getPartialSize()
public void setPartialSize(long partialSize)
partialSize
- the partialSize to setpublic int compareTo(CaArrayFile o)
compareTo
in interface java.lang.Comparable<CaArrayFile>
public java.lang.String toString()
toString
in class AbstractCaArrayObject
@NotNull public java.lang.String getStatus()
public java.lang.String getType()
public void setType(java.lang.String type)
type
- the type to setpublic gov.nih.nci.caarray.validation.FileValidationResult getValidationResult()
public void setValidationResult(gov.nih.nci.caarray.validation.FileValidationResult validationResult)
validationResult
- the validationResult to setpublic java.util.Collection<? extends gov.nih.nci.caarray.security.Protectable> relatedProtectables()
relatedProtectables
in interface gov.nih.nci.caarray.security.ProtectableDescendent
public boolean isImportable()
public boolean isValidatable()
public boolean isUnparsedAndReimportable()
@NotNull public java.net.URI getDataHandle()
public void setDataHandle(java.net.URI dataHandle)
dataHandle
- the dataHandle to setpublic void addChild(CaArrayFile child)
child
- the child CaArrayFile to add.public void removeChild(CaArrayFile child)
child
- the child CaArrayFile to remove.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |