Package tethys

Class DocumentInfo

java.lang.Object

tethys.DocumentInfo

All Implemented Interfaces:

Comparable<DocumentInfo>

Direct Known Subclasses:

DocumentNilusObject

public class DocumentInfo
extends Object
implements Comparable<DocumentInfo>

Basic information about a document that can be used to make document lists.

Author:

dg50

Constructor Summary

Constructors

Constructor	Description
DocumentInfo(Collection collection, String documentName, String documentId)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DocumentInfo o)
Collection	getCollection()
String	getDocumentId()
String	getDocumentName()
boolean	isThisPAMGuardDataSet()	Document is part of current PAMGuard dataset
boolean	isThisTethysProject()	Document is part of this Tethys Project
void	setThisPAMGuardDataSet(boolean thisPAMGuardDataSet)	Document is part of current PAMGuard dataset
void	setThisTethysProject(boolean thisTethysProject)	Document is part of this Tethys Project
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentInfo

public DocumentInfo(Collection collection,
 String documentName,
 String documentId)

Parameters:

collection -

documentName -

documentId -

Method Details

compareTo

public int compareTo(DocumentInfo o)

Specified by:

compareTo in interface Comparable<DocumentInfo>

getCollection

public Collection getCollection()

Returns:

the collection

getDocumentName

public String getDocumentName()

Returns:

the documentName

getDocumentId

public String getDocumentId()

Returns:

the documentId

isThisTethysProject

public boolean isThisTethysProject()

Document is part of this Tethys Project

Returns:

the thisTethysProject

setThisTethysProject

public void setThisTethysProject(boolean thisTethysProject)

Document is part of this Tethys Project

Parameters:

thisTethysProject - the thisTethysProject to set

isThisPAMGuardDataSet

public boolean isThisPAMGuardDataSet()

Document is part of current PAMGuard dataset

Returns:

the thisPAMGuardDataSet

setThisPAMGuardDataSet

public void setThisPAMGuardDataSet(boolean thisPAMGuardDataSet)

Document is part of current PAMGuard dataset

Parameters:

thisPAMGuardDataSet - the thisPAMGuardDataSet to set

toString

public String toString()

Overrides:

toString in class Object