org.proteios.core
Class FileType

java.lang.Object
  org.proteios.core.BasicItem<FileTypeData>
      org.proteios.core.FileType

All Implemented Interfaces:

AccessControlled, Identifiable, Nameable, SystemItem

public class FileType
extends BasicItem<FileTypeData>
implements Nameable, SystemItem

This class is used to represent the type of File items in Proteios.

Version:

2.0

Author:

enell, Nicklas

See Also:

File

Last modified

$Date: 2011-03-03 14:48:16 +0100 (Thu, 03 Mar 2011) $

Field Summary

static String	DECYDER_BVA_XML
static String	DTA_PEAK_LIST
static String	IMAGE The id for the FileType item representing an image file.
static String	MASCOT_XML
static String	MGF_PEAK_LIST
static String	MSINSPECT_FEATURES
static String	MZDATA
static String	MZML
static String	MZXML
static String	OMSSA_PARAMETERS
static String	OMSSA_RESULT_XML
static String	OPENMS_FEATURES
static String	PEP_XML
static String	PICK_LIST
static String	PIUMS_MATCHER
static String	PIUMS_PEPEX
static String	PIUMS_PEPFIL
static String	PKL_PEAK_LIST
static String	PLATE_MAPPING The id for the FileType item representing a plate mapping file.
static String	PLGS_PEAK_LIST
static String	PRINT_MAP The id for the FileType item representing a print map file.
static String	PROTOCOL The id for the FileType item representing a protocol.
static String	RAW_DATA The id for the FileType item representing a raw data file.
static String	RAW_SPECTRUM
static String	REPORTER_MAP The id for the FileType item representing a reporter map file.
static String	SCANNED_GEL_IMAGE
static String	SHW_RESULT
static String	SPOT_IMAGES The id for the FileType item representing a spot images file.
static String	TANDEM_RESULT
static Item	TYPE The type of item represented by this class.

Fields inherited from interface org.proteios.core.Nameable

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Method Summary

String	getDescription() Get the description for the item.
String	getName() Get the name of the item.
static ItemQuery<FileType>	getQuery() Get a query configured to retrieve FileType items.
String	getSystemId() Get the system id for the item.
Item	getType() Get the type of item represented by the object.
boolean	isSystemItem() Check if the item is a system item or not.
boolean	isUsed() Check if: any file has been assigned this type
void	setDescription(String description) Set the description for the item.
void	setName(String name) Set the name of the item.

Methods inherited from class org.proteios.core.BasicItem

checkPermission, equals, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.proteios.core.Identifiable

getId, getVersion

Methods inherited from interface org.proteios.core.AccessControlled

checkPermission, hasPermission

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.FILETYPE, getType()

PROTOCOL

public static final String PROTOCOL

The id for the FileType item representing a protocol.

See Also:

Constant Field Values

RAW_DATA

public static final String RAW_DATA

The id for the FileType item representing a raw data file.

See Also:

Constant Field Values

PLATE_MAPPING

public static final String PLATE_MAPPING

The id for the FileType item representing a plate mapping file.

See Also:

Constant Field Values

REPORTER_MAP

public static final String REPORTER_MAP

The id for the FileType item representing a reporter map file.

See Also:

Constant Field Values

PRINT_MAP

public static final String PRINT_MAP

The id for the FileType item representing a print map file.

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

The id for the FileType item representing an image file.

See Also:

Constant Field Values

SPOT_IMAGES

public static final String SPOT_IMAGES

The id for the FileType item representing a spot images file.

See Also:

Constant Field Values

SCANNED_GEL_IMAGE

public static final String SCANNED_GEL_IMAGE

See Also:

Constant Field Values

PICK_LIST

public static final String PICK_LIST

See Also:

Constant Field Values

SHW_RESULT

public static final String SHW_RESULT

See Also:

Constant Field Values

RAW_SPECTRUM

public static final String RAW_SPECTRUM

See Also:

Constant Field Values

DTA_PEAK_LIST

public static final String DTA_PEAK_LIST

See Also:

Constant Field Values

PKL_PEAK_LIST

public static final String PKL_PEAK_LIST

See Also:

Constant Field Values

MGF_PEAK_LIST

public static final String MGF_PEAK_LIST

See Also:

Constant Field Values

MZDATA

public static final String MZDATA

See Also:

Constant Field Values

MZML

public static final String MZML

See Also:

Constant Field Values

MZXML

public static final String MZXML

See Also:

Constant Field Values

MASCOT_XML

public static final String MASCOT_XML

See Also:

Constant Field Values

TANDEM_RESULT

public static final String TANDEM_RESULT

See Also:

Constant Field Values

PIUMS_MATCHER

public static final String PIUMS_MATCHER

See Also:

Constant Field Values

PIUMS_PEPEX

public static final String PIUMS_PEPEX

See Also:

Constant Field Values

PIUMS_PEPFIL

public static final String PIUMS_PEPFIL

See Also:

Constant Field Values

DECYDER_BVA_XML

public static final String DECYDER_BVA_XML

See Also:

Constant Field Values

PEP_XML

public static final String PEP_XML

See Also:

Constant Field Values

PLGS_PEAK_LIST

public static final String PLGS_PEAK_LIST

See Also:

Constant Field Values

OMSSA_PARAMETERS

public static final String OMSSA_PARAMETERS

See Also:

Constant Field Values

OMSSA_RESULT_XML

public static final String OMSSA_RESULT_XML

See Also:

Constant Field Values

MSINSPECT_FEATURES

public static final String MSINSPECT_FEATURES

See Also:

Constant Field Values

OPENMS_FEATURES

public static final String OPENMS_FEATURES

See Also:

Constant Field Values

Method Detail

getQuery

public static ItemQuery<FileType> getQuery()
                                    throws BaseException

Get a query configured to retrieve FileType items.

Returns:

An ItemQuery object

Throws:

BaseException

getType

public Item getType()

Description copied from interface: Identifiable

Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.

Specified by:

getType in interface Identifiable

Returns:

A value indicating the type of item

getName

public String getName()

Description copied from interface: Nameable

Get the name of the item.

Specified by:

getName in interface Nameable

Returns:

A String with the name of the item

setName

public void setName(String name)
             throws PermissionDeniedException,
                    InvalidDataException

Description copied from interface: Nameable

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the Nameable.MAX_NAME_LENGTH constant.

Specified by:

setName in interface Nameable

Parameters:

name - The new name for the item

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the name is null or longer than specified by the Nameable.MAX_NAME_LENGTH constant

getDescription

public String getDescription()

Description copied from interface: Nameable

Get the description for the item.

Specified by:

getDescription in interface Nameable

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)
                    throws PermissionDeniedException,
                           InvalidDataException

Description copied from interface: Nameable

Set the description for the item. The description can be null but mustn't be longer than the value specified by the Nameable.MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface Nameable

Parameters:

description - The new description for the item

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the description longer than specified by the Nameable.MAX_DESCRIPTION_LENGTH constant

getSystemId

public String getSystemId()

Description copied from interface: SystemItem

Get the system id for the item.

Specified by:

getSystemId in interface SystemItem

Returns:

The id of the item or null if it is not a system item

isSystemItem

public boolean isSystemItem()

Description copied from interface: SystemItem

Check if the item is a system item or not. A system item have a non-null value for the system id.

Specified by:

isSystemItem in interface SystemItem

Returns:

TRUE if this item is a system item, FALSE otherwise

isUsed

public boolean isUsed()
               throws BaseException

Check if:

• any file has been assigned this type

Specified by:

isUsed in class BasicItem<FileTypeData>

Returns:

TRUE if this FileType is used.

Throws:

BaseException - If there is an error