File (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.security.PermissionsAware
- - net.sourceforge.seqware.common.model.File

All Implemented Interfaces:

Serializable, Comparable<File>, Annotatable<FileAttribute>, FirstTierModel
```
public class File
extends PermissionsAware
implements Serializable, Comparable<File>, Annotatable<FileAttribute>, FirstTierModel
```
File class.

Version:

$Id: $Id

Author:

boconnor

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

File()
Constructor for File.

Constructors
Constructor and Description
`File()` Constructor for File.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(File that)`
`boolean`	`equals(Object other)`
`Set<FileAttribute>`	`getAnnotations()` Get the annotations for this model
`String`	`getDescription()` Getter for the field `description`.
`Set<FileAttribute>`	`getFileAttributes()` Getter for the field `fileAttributes`.
`Integer`	`getFileId()` Getter for the field `fileId`.
`String`	`getFileName()` getFileName.
`String`	`getFilePath()` Getter for the field `filePath`.
`FileType`	`getFileType()` Getter for the field `fileType`.
`Boolean`	`getIsSelected()` Getter for the field `isSelected`.
`String`	`getJsonEscapeDescription()` getJsonEscapeDescription.
`String`	`getJsonEscapeFileName()` getJsonEscapeFileName.
`String`	`getMd5sum()` Getter for the field `md5sum`.
`String`	`getMetaType()` Getter for the field `metaType`.
`Registration`	`getOwner()` Getter for the field `owner`.
`Set<Processing>`	`getProcessings()` Getter for the field `processings`.
`Long`	`getSize()` Getter for the field `size`.
`Boolean`	`getSkip()`
`Integer`	`getSwAccession()` Getter for the field `swAccession`.
`String`	`getType()` Getter for the field `type`.
`String`	`getUrl()` Getter for the field `url`.
`String`	`getUrlLabel()` Getter for the field `urlLabel`.
`boolean`	`givesPermissionInternal(Registration registration, Set<Integer> considered)` Short-circuit permission checking by providing a set of entities that have already been checked
`int`	`hashCode()`
`void`	`setDescription(String description)` Setter for the field `description`.
`void`	`setFileAttributes(Set<FileAttribute> fileAttributes)` Setter for the field `fileAttributes`.
`void`	`setFileId(Integer fileId)` Setter for the field `fileId`.
`void`	`setFilePath(String filePath)` Setter for the field `filePath`.
`void`	`setFileType(FileType fileType)` Setter for the field `fileType`.
`void`	`setIsSelected(Boolean isSelected)` Setter for the field `isSelected`.
`void`	`setMd5sum(String md5sum)` Setter for the field `md5sum`.
`void`	`setMetaType(String metaType)` Setter for the field `metaType`.
`void`	`setOwner(Registration owner)` Setter for the field `owner`.
`void`	`setProcessings(Set<Processing> processing)` Setter for the field `processings`.
`void`	`setSize(Long size)` Setter for the field `size`.
`void`	`setSkip(Boolean skip)`
`void`	`setSwAccession(Integer swAccession)` Setter for the field `swAccession`.
`void`	`setType(String type)` Setter for the field `type`.
`void`	`setUrl(String url)` Setter for the field `url`.
`void`	`setUrlLabel(String urlLabel)` Setter for the field `urlLabel`.
`String`	`toString()`

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware
givesPermission, givesPermission

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - File
```
public File()
```
    Constructor for File.
- Method Detail
  - getProcessings
```
public Set<Processing> getProcessings()
```
    Getter for the field processings.
    
    Returns:
    a Set object.
  - setProcessings
```
public void setProcessings(Set<Processing> processing)
```
    Setter for the field processings.
    
    Parameters:
    processing - a Set object.
  - compareTo
```
public int compareTo(File that)
```
    Specified by:
    
    compareTo in interface Comparable<File>
    
    Parameters:
    that -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
    
    Parameters:
    other -
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFileName
```
public String getFileName()
```
    getFileName.
    
    Returns:
    a String object.
  - getJsonEscapeFileName
```
public String getJsonEscapeFileName()
```
    getJsonEscapeFileName.
    
    Returns:
    a String object.
  - getFileId
```
public Integer getFileId()
```
    Getter for the field fileId.
    
    Returns:
    a Integer object.
  - setFileId
```
public void setFileId(Integer fileId)
```
    Setter for the field fileId.
    
    Parameters:
    fileId - a Integer object.
  - getFilePath
```
public String getFilePath()
```
    Getter for the field filePath.
    
    Returns:
    a String object.
  - setFilePath
```
public void setFilePath(String filePath)
```
    Setter for the field filePath.
    
    Parameters:
    filePath - a String object.
  - getType
```
public String getType()
```
    Getter for the field type.
    
    Returns:
    a String object.
  - setType
```
public void setType(String type)
```
    Setter for the field type.
    
    Parameters:
    type - a String object.
  - getMetaType
```
public String getMetaType()
```
    Getter for the field metaType.
    
    Returns:
    a String object.
  - setMetaType
```
public void setMetaType(String metaType)
```
    Setter for the field metaType.
    
    Parameters:
    metaType - a String object.
  - getJsonEscapeDescription
```
public String getJsonEscapeDescription()
```
    getJsonEscapeDescription.
    
    Returns:
    a String object.
  - getDescription
```
public String getDescription()
```
    Getter for the field description.
    
    Returns:
    a String object.
  - setDescription
```
public void setDescription(String description)
```
    Setter for the field description.
    
    Parameters:
    description - a String object.
  - getSwAccession
```
public Integer getSwAccession()
```
    Getter for the field swAccession.
    
    Specified by:
    
    getSwAccession in interface FirstTierModel
    
    Returns:
    a Integer object.
  - setSwAccession
```
public void setSwAccession(Integer swAccession)
```
    Setter for the field swAccession.
    
    Parameters:
    swAccession - a Integer object.
  - getOwner
```
public Registration getOwner()
```
    Getter for the field owner.
    
    Returns:
    a Registration object.
  - setOwner
```
public void setOwner(Registration owner)
```
    Setter for the field owner.
    
    Parameters:
    owner - a Registration object.
  - getIsSelected
```
public Boolean getIsSelected()
```
    Getter for the field isSelected.
    
    Returns:
    a Boolean object.
  - setIsSelected
```
public void setIsSelected(Boolean isSelected)
```
    Setter for the field isSelected.
    
    Parameters:
    isSelected - a Boolean object.
  - getUrl
```
public String getUrl()
```
    Getter for the field url.
    
    Returns:
    a String object.
  - setUrl
```
public void setUrl(String url)
```
    Setter for the field url.
    
    Parameters:
    url - a String object.
  - getUrlLabel
```
public String getUrlLabel()
```
    Getter for the field urlLabel.
    
    Returns:
    a String object.
  - setUrlLabel
```
public void setUrlLabel(String urlLabel)
```
    Setter for the field urlLabel.
    
    Parameters:
    urlLabel - a String object.
  - getMd5sum
```
public String getMd5sum()
```
    Getter for the field md5sum.
    
    Returns:
    a String object.
  - setMd5sum
```
public void setMd5sum(String md5sum)
```
    Setter for the field md5sum.
    
    Parameters:
    md5sum - a String object.
  - getFileType
```
public FileType getFileType()
```
    Getter for the field fileType.
    
    Returns:
    a FileType object.
  - setFileType
```
public void setFileType(FileType fileType)
```
    Setter for the field fileType.
    
    Parameters:
    fileType - a FileType object.
  - givesPermissionInternal
```
public boolean givesPermissionInternal(Registration registration,
                              Set<Integer> considered)
```
    Description copied from class: PermissionsAware
    
    Short-circuit permission checking by providing a set of entities that have already been checked
    
    Specified by:
    
    givesPermissionInternal in class PermissionsAware
    
    Returns:
  - getFileAttributes
```
public Set<FileAttribute> getFileAttributes()
```
    Getter for the field fileAttributes.
    
    Returns:
    a Set object.
  - setFileAttributes
```
public void setFileAttributes(Set<FileAttribute> fileAttributes)
```
    Setter for the field fileAttributes.
    
    Parameters:
    fileAttributes - a Set object.
  - getSize
```
public Long getSize()
```
    Getter for the field size.
    
    Returns:
    a Long object.
  - setSize
```
public void setSize(Long size)
```
    Setter for the field size.
    
    Parameters:
    size - a Long object.
  - getSkip
```
public Boolean getSkip()
```
    Returns:
    the skip
  - setSkip
```
public void setSkip(Boolean skip)
```
    Parameters:
    skip - the skip to set
  - getAnnotations
```
public Set<FileAttribute> getAnnotations()
```
    Description copied from interface: Annotatable
    
    Get the annotations for this model
    
    Specified by:
    
    getAnnotations in interface Annotatable<FileAttribute>
    
    Returns:

Class File

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.seqware.common.security.PermissionsAware

Methods inherited from class java.lang.Object

Constructor Detail

File

Method Detail

getProcessings

setProcessings

compareTo

toString

equals

hashCode

getFileName

getJsonEscapeFileName

getFileId

setFileId

getFilePath

setFilePath

getType

setType

getMetaType

setMetaType

getJsonEscapeDescription

getDescription

setDescription

getSwAccession

setSwAccession

getOwner

setOwner

getIsSelected

setIsSelected

getUrl

setUrl

getUrlLabel

setUrlLabel

getMd5sum

setMd5sum

getFileType

setFileType

givesPermissionInternal

getFileAttributes

setFileAttributes

getSize

setSize

getSkip

setSkip

getAnnotations