net.sf.basedb.core.data
Class DataFileTypeData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.DataFileTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData

public class DataFileTypeData
extends BasicData
implements NameableData, RemovableData

This class hols information about individual files attached to items that store data in files instead of in the database.

Version:

2.5

Author:

Nicklas

See Also:

DataFileType, Data API - Experimental platforms

Last modified

$Date: 2008-09-11 22:11:02 +0200 (Thu, 11 Sep 2008) $

Hibernate: class

table="`DataFileTypes`" lazy="false"

Field Summary

private String	description
private String	extension
private String	externalId
private FileTypeData	genericType
private int	itemType
static int	MAX_CLASSNAME_LENGTH The maximum length of the class name that can be stored in the database.
static int	MAX_EXTENSION_LENGTH The maximum length of the file extension that can be stored in the database.
static int	MAX_EXTERNAL_ID_LENGTH The maximum length of the external ID that can be stored in the database.
static int	MAX_JARPATH_LENGTH
private Set<FileSetMemberData>	members
private String	metadataReaderClass
private String	metadataReaderJarPath
private String	name
private Set<PlatformFileTypeData>	platforms
private boolean	removed
private String	validatorClass
private String	validatorJarPath

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

DataFileTypeData()

Method Summary

String	getDescription() Get the description for the item.
String	getExtension() Get the extension that files of this type usually have.
String	getExternalId() Get the external id for the item.
(package private) Set<FileSetMemberData>	getFileSetMembers() This is the inverse end.
FileTypeData	getGenericType() Get the generic file type of files with this member type.
int	getItemType() The item type this file type can be associated with.
String	getMetadataReaderClass() Get the class name of the Java class that extracts metadata from this file type.
String	getMetadataReaderJarPath() Get the path to the JAR file where the validator class is located.
String	getName() Get the name of the item.
(package private) Set<PlatformFileTypeData>	getPlatforms() This is the inverse end.
String	getValidatorClass() Get the class name of the Java class that is the validator for this file type.
String	getValidatorJarPath() Get the path to the JAR file where the validator class is located.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setExtension(String extension)
void	setExternalId(String externalId)
(package private) void	setFileSetMembers(Set<FileSetMemberData> members)
void	setGenericType(FileTypeData genericType)
void	setItemType(int itemType)
void	setMetadataReaderClass(String metadataReaderClass)
void	setMetadataReaderJarPath(String metadataReaderJarPath)
void	setName(String name) Set the name of the item.
(package private) void	setPlatforms(Set<PlatformFileTypeData> platforms)
void	setRemoved(boolean removed) Set the removed flag for this item.
void	setValidatorClass(String validatorClass)
void	setValidatorJarPath(String validatorJarPath)

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

MAX_EXTERNAL_ID_LENGTH

public static final int MAX_EXTERNAL_ID_LENGTH

The maximum length of the external ID that can be stored in the database.

See Also:

setExternalId(String), Constant Field Values

externalId

private String externalId

MAX_EXTENSION_LENGTH

public static final int MAX_EXTENSION_LENGTH

The maximum length of the file extension that can be stored in the database.

See Also:

Constant Field Values

extension

private String extension

MAX_CLASSNAME_LENGTH

public static final int MAX_CLASSNAME_LENGTH

The maximum length of the class name that can be stored in the database.

See Also:

Constant Field Values

validatorClass

private String validatorClass

MAX_JARPATH_LENGTH

public static final int MAX_JARPATH_LENGTH

See Also:

Constant Field Values

validatorJarPath

private String validatorJarPath

metadataReaderClass

private String metadataReaderClass

metadataReaderJarPath

private String metadataReaderJarPath

itemType

private int itemType

genericType

private FileTypeData genericType

platforms

private Set<PlatformFileTypeData> platforms

members

private Set<FileSetMemberData> members

Constructor Detail

DataFileTypeData

public DataFileTypeData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

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

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

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

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

getExternalId

public String getExternalId()

Get the external id for the item.

Returns:

The external id of the item

Hibernate: property

column="`external_id`" type="string" length="255" not-null="true" update="false" unique="true"

setExternalId

public void setExternalId(String externalId)

getExtension

public String getExtension()

Get the extension that files of this type usually have. Null if there is no specific extension.

Hibernate: property

column="extension" type="string" length="255"

setExtension

public void setExtension(String extension)

getValidatorClass

public String getValidatorClass()

Get the class name of the Java class that is the validator for this file type. The class must implement the DataFileValidator interface. Null if there is no validator for this file type.

Hibernate: property

column="`validator_class`" type="string" length="255" not-null="false"

setValidatorClass

public void setValidatorClass(String validatorClass)

getValidatorJarPath

public String getValidatorJarPath()

Get the path to the JAR file where the validator class is located. If the value is null the value must be in the classpath.

Returns:

The path to the JAR file

Since:

2.6

Hibernate: property

column="`validator_jarpath`" type="text" not-null="false"

setValidatorJarPath

public void setValidatorJarPath(String validatorJarPath)

getMetadataReaderClass

public String getMetadataReaderClass()

Get the class name of the Java class that extracts metadata from this file type. The class must implement the DataFileMetadataReader interface. Null if there is no extractor for this file type.

Hibernate: property

column="`extractor_class`" type="string" length="255" not-null="false"

setMetadataReaderClass

public void setMetadataReaderClass(String metadataReaderClass)

getMetadataReaderJarPath

public String getMetadataReaderJarPath()

Get the path to the JAR file where the validator class is located. If the value is null the value must be in the classpath.

Returns:

The path to the JAR file

Since:

2.6

Hibernate: property

column="`extractor_jarpath`" type="text" not-null="false"

setMetadataReaderJarPath

public void setMetadataReaderJarPath(String metadataReaderJarPath)

getItemType

public int getItemType()

The item type this file type can be associated with.

Hibernate: property

column="`item_type`" type="int" not-null="true" update="false"

setItemType

public void setItemType(int itemType)

getGenericType

public FileTypeData getGenericType()

Get the generic file type of files with this member type.

Hibernate: column

name="`filetype_id`" not-null="false"

Hibernate: many-to-one

outer-join="false"

setGenericType

public void setGenericType(FileTypeData genericType)

getPlatforms

Set<PlatformFileTypeData> getPlatforms()

This is the inverse end.

See Also:

PlatformFileTypeData.getDataFileType()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`datafiletype_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.PlatformFileTypeData"

setPlatforms

void setPlatforms(Set<PlatformFileTypeData> platforms)

getFileSetMembers

Set<FileSetMemberData> getFileSetMembers()

This is the inverse end.

See Also:

FileSetMemberData.getDataFileType()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`datafiletype_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.FileSetMemberData"

setFileSetMembers

void setFileSetMembers(Set<FileSetMemberData> members)