org.ecocean

Class SinglePhotoVideo

java.lang.Object

org.ecocean.DataCollectionEvent

org.ecocean.SinglePhotoVideo

All Implemented Interfaces:

Serializable

public class SinglePhotoVideo
extends DataCollectionEvent

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private String	copyrightOwner
private String	copyrightStatement
(package private) String	correspondingStoryID
(package private) String	correspondingUsername
private String	filename
private String	fullFileSystemPath
private List<Keyword>	keywords
private PatterningPassport	patterningPassport
private static long	serialVersionUID
private static String	type

Constructor Summary

Constructors

Constructor and Description
SinglePhotoVideo() Empty constructor required for JDO persistence
SinglePhotoVideo(Encounter enc, org.apache.commons.fileupload.FileItem formFile, String context, String dataDir)
SinglePhotoVideo(String correspondingEncounterNumber, File file)
SinglePhotoVideo(String correspondingEncounterNumber, String filename, String fullFileSystemPath)

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyword(Keyword dce)
String	asUrl(Encounter enc, String baseDir)
String	getCopyrightOwner()
String	getCopyrightStatement()
String	getCorrespondingStoryID()
String	getCorrespondingUsername()
File	getFile() Returns the photo or video represented by this object as a java.io.File This is a convenience method.
String	getFilename()
String	getFullFileSystemPath()
List<Keyword>	getKeywords()
PatterningPassport	getPatterningPassport()
File	getPatterningPassportFile()
void	removeKeyword(int num)
void	removeKeyword(Keyword num)
boolean	scaleTo(String context, int width, int height, String targetPath)
boolean	scaleToWatermark(String context, int width, int height, String targetPath, String watermark)
void	setCopyrightOwner(String owner)
void	setCopyrightStatement(String statement)
void	setCorrespondingStoryID(String userID)
void	setCorrespondingUsername(String username)
void	setFilename(String newName)
void	setFullFileSystemPath(String newPath)
void	setPatterningPassport(PatterningPassport patterningPassport)

Methods inherited from class org.ecocean.DataCollectionEvent

getCollectionCode, getCollectionID, getCorrespondingEncounterNumber, getDataCollectionEventID, getDatasetID, getDatasetName, getEventEndDate, getEventRemarks, getEventStartDate, getFieldNotes, getFieldNumber, getHTMLString, getInstitutionCode, getInstitutionID, getSamplingEffort, getSamplingProtocol, getType, resetAbstractClassParameters, setCollectionCode, setCollectionID, setCorrespondingEncounterNumber, setDataCollectionEventID, setDatasetID, setDatasetName, setEventEndDate, setEventRemarks, setEventStartDate, setFieldNotes, setFieldNumber, setInstitutionCode, setInstitutionID, setSamplingEffort, setSamplingProtocol

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

patterningPassport

private PatterningPassport patterningPassport

filename

private String filename

fullFileSystemPath

private String fullFileSystemPath

correspondingUsername

String correspondingUsername

correspondingStoryID

String correspondingStoryID

type

private static String type

copyrightOwner

private String copyrightOwner

copyrightStatement

private String copyrightStatement

keywords

private List<Keyword> keywords

Constructor Detail

SinglePhotoVideo

public SinglePhotoVideo()

Empty constructor required for JDO persistence

SinglePhotoVideo

public SinglePhotoVideo(String correspondingEncounterNumber,
                String filename,
                String fullFileSystemPath)

SinglePhotoVideo

public SinglePhotoVideo(String correspondingEncounterNumber,
                File file)

SinglePhotoVideo

public SinglePhotoVideo(Encounter enc,
                org.apache.commons.fileupload.FileItem formFile,
                String context,
                String dataDir)
                 throws Exception

Throws:

Exception

Method Detail

getFile

public File getFile()

Returns the photo or video represented by this object as a java.io.File This is a convenience method.

Returns:

java.io.File

asUrl

public String asUrl(Encounter enc,
           String baseDir)

getFilename

public String getFilename()

setFilename

public void setFilename(String newName)

getFullFileSystemPath

public String getFullFileSystemPath()

setFullFileSystemPath

public void setFullFileSystemPath(String newPath)

getCopyrightOwner

public String getCopyrightOwner()

setCopyrightOwner

public void setCopyrightOwner(String owner)

getCopyrightStatement

public String getCopyrightStatement()

setCopyrightStatement

public void setCopyrightStatement(String statement)

addKeyword

public void addKeyword(Keyword dce)

removeKeyword

public void removeKeyword(int num)

getKeywords

public List<Keyword> getKeywords()

removeKeyword

public void removeKeyword(Keyword num)

getPatterningPassport

public PatterningPassport getPatterningPassport()

getPatterningPassportFile

public File getPatterningPassportFile()

setPatterningPassport

public void setPatterningPassport(PatterningPassport patterningPassport)

Parameters:

patterningPassport - the patterningPassport to set

getCorrespondingUsername

public String getCorrespondingUsername()

setCorrespondingUsername

public void setCorrespondingUsername(String username)

getCorrespondingStoryID

public String getCorrespondingStoryID()

setCorrespondingStoryID

public void setCorrespondingStoryID(String userID)

scaleTo

public boolean scaleTo(String context,
              int width,
              int height,
              String targetPath)

scaleToWatermark

public boolean scaleToWatermark(String context,
                       int width,
                       int height,
                       String targetPath,
                       String watermark)