Project (Coser :: Business 1.6-SNAPSHOT API)

java.lang.Object
- fr.ifremer.coser.bean.AbstractEntity
- - fr.ifremer.coser.bean.Project

All Implemented Interfaces:

Serializable
```
public class Project
extends AbstractEntity
```
Project. For now, just composed of four simple String lists for data list. Also composed of loaded reftax (with header REFTAX_SPECIES_HEADER). "C_Perm";"NumSys";"NivSys";"C_VALIDE";"L_VALIDE";"AA_VALIDE";"C_TxPère";"Taxa"

Author:

chatellier

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`author`
`protected String`	`catchFile` Utilisé seulement lors de la création du projet (sinon, non valorisé).
`protected String`	`catchFileName` Nom original du fichier de captures.
`protected String`	`comment` Commentaire du projet.
`protected Control`	`control` Project control.
`protected Date`	`creationDate`
`protected SpeciesFieldType`	`displaySpeciesType` Species field type used for user display.
`protected String`	`haulFile` Utilisé seulement lors de la création du projet (sinon, non valorisé).
`protected String`	`haulFileName` Nom original du fichier de traits.
`protected String`	`lengthFile` Utilisé seulement lors de la création du projet (sinon, non valorisé).
`protected String`	`lengthFileName` Nom original du fichier de tailles.
`protected List<File>`	`maps` File des cartes (plus facile a gerer en tant que file dans l'ui, mais seul le filename est sauvegardé).
`protected String`	`name`
`protected SpeciesFieldType`	`outputSpeciesType` Species field type used for rsufi output files.
`static String`	`PROPERTY_SELECTIONS`
`static String[]`	`REFTAX_SPECIES_HEADER`
`protected DataStorage`	`refTaxSpecies` Reftax SIH.
`protected LinkedHashMap<String,String>`	`refTaxSpeciesMap` Map de cache entre les codes especes et la visualisation utilisateur.
`protected Map<String,Selection>`	`selections` Project selections.
`protected SpeciesFieldType`	`storageSpeciesType` Species field type used in storage.
`protected String`	`strataFile` Utilisé seulement lors de la création du projet (sinon, non valorisé).
`protected String`	`strataFileName` Nom original du fichier de strates.
`static String[]`	`TYPE_ESPECE_HEADER`
`protected DataStorage`	`typeEspeces` Type especes

Fields inherited from class fr.ifremer.coser.bean.AbstractEntity
support

Constructor Summary

Constructors
Constructor and Description

Project()

Project(String name)

Constructors
Constructor and Description
`Project()`
`Project(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSelections(Selection selection)`
`void`	`clearData()` Force all container data clear to force free memory.
`void`	`fromProperties(Properties props, File mapDirectory)`
`String`	`getAuthor()`
`String`	`getCatchFile()`
`String`	`getCatchFileName()`
`String`	`getComment()`
`Control`	`getControl()`
`Date`	`getCreationDate()`
`String`	`getDataStorageFileName(CoserConstants.Category category, String suffix)` Retourne le nom de stockage d'un fichier de données suivant la categories de fichier demandé.
`String`	`getDisplaySpeciesText(String speciesCode)` Retourne le nom de visualisation de l'espèce conformement à la configuration du projet.
`SpeciesFieldType`	`getDisplaySpeciesType()`
`String`	`getHaulFile()`
`String`	`getHaulFileName()`
`String`	`getLengthFile()`
`String`	`getLengthFileName()`
`List<File>`	`getMaps()`
`String`	`getName()`
`SpeciesFieldType`	`getOutputSpeciesType()`
`DataStorage`	`getRefTaxSpecies()`
`LinkedHashMap<String,String>`	`getRefTaxSpeciesMap()` Recuperation de la map de cache code especes/visualisation utilisateur.
`Map<String,Selection>`	`getSelections()`
`SpeciesFieldType`	`getStorageSpeciesType()`
`String`	`getStrataFile()`
`String`	`getStrataFileName()`
`DataStorage`	`getTypeEspeces()`
`void`	`setAuthor(String author)`
`void`	`setCatchFile(String catchFile)`
`void`	`setCatchFileName(String catchFileName)`
`void`	`setComment(String comment)`
`void`	`setControl(Control control)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setDisplaySpeciesType(SpeciesFieldType displaySpeciesType)`
`void`	`setHaulFile(String haulFile)`
`void`	`setHaulFileName(String haulFileName)`
`void`	`setLengthFile(String lengthFile)`
`void`	`setLengthFileName(String lengthFileName)`
`void`	`setMaps(List<File> maps)`
`void`	`setName(String name)`
`void`	`setOutputSpeciesType(SpeciesFieldType outputSpeciesType)`
`void`	`setRefTaxSpecies(DataStorage refTaxSpecies)`
`void`	`setRefTaxSpeciesMap(LinkedHashMap<String,String> refTaxSpeciesMap)` Modification de la map de cache code especes/visualisation utilisateur.
`void`	`setSelections(Map<String,Selection> selections)`
`void`	`setStorageSpeciesType(SpeciesFieldType storageSpeciesType)`
`void`	`setStrataFile(String strataFile)`
`void`	`setStrataFileName(String strataFileName)`
`void`	`setTypeEspeces(DataStorage typeEspeces)`
`Properties`	`toProperties()`

Methods inherited from class fr.ifremer.coser.bean.AbstractEntity
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeSupport, removePropertyChangeListener, removePropertyChangeListener

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

Field Detail
- REFTAX_SPECIES_HEADER
```
public static final String[] REFTAX_SPECIES_HEADER
```
- TYPE_ESPECE_HEADER
```
public static final String[] TYPE_ESPECE_HEADER
```
- PROPERTY_SELECTIONS
```
public static final String PROPERTY_SELECTIONS
```
  See Also:
  Constant Field Values
- name
```
protected String name
```
- author
```
protected String author
```
- catchFile
```
protected String catchFile
```
  Utilisé seulement lors de la création du projet (sinon, non valorisé).
- haulFile
```
protected String haulFile
```
  Utilisé seulement lors de la création du projet (sinon, non valorisé).
- lengthFile
```
protected String lengthFile
```
  Utilisé seulement lors de la création du projet (sinon, non valorisé).
- strataFile
```
protected String strataFile
```
  Utilisé seulement lors de la création du projet (sinon, non valorisé).
- catchFileName
```
protected String catchFileName
```
  Nom original du fichier de captures.
- haulFileName
```
protected String haulFileName
```
  Nom original du fichier de traits.
- lengthFileName
```
protected String lengthFileName
```
  Nom original du fichier de tailles.
- strataFileName
```
protected String strataFileName
```
  Nom original du fichier de strates.
- maps
```
protected List<File> maps
```
  File des cartes (plus facile a gerer en tant que file dans l'ui, mais seul le filename est sauvegardé).
- comment
```
protected String comment
```
  Commentaire du projet.
- creationDate
```
protected Date creationDate
```
- control
```
protected Control control
```
  Project control.
- selections
```
protected Map<String,Selection> selections
```
  Project selections.
- refTaxSpecies
```
protected DataStorage refTaxSpecies
```
  Reftax SIH.
- refTaxSpeciesMap
```
protected LinkedHashMap<String,String> refTaxSpeciesMap
```
  Map de cache entre les codes especes et la visualisation utilisateur.
- typeEspeces
```
protected DataStorage typeEspeces
```
  Type especes
- storageSpeciesType
```
protected SpeciesFieldType storageSpeciesType
```
  Species field type used in storage.
- displaySpeciesType
```
protected SpeciesFieldType displaySpeciesType
```
  Species field type used for user display.
- outputSpeciesType
```
protected SpeciesFieldType outputSpeciesType
```
  Species field type used for rsufi output files.

Constructor Detail

Project
```
public Project()
```

Project
```
public Project(String name)
```

Method Detail

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getAuthor
```
public String getAuthor()
```

setAuthor
```
public void setAuthor(String author)
```

getCatchFile
```
public String getCatchFile()
```

setCatchFile

public void setCatchFile(String catchFile)

getHaulFile
```
public String getHaulFile()
```

setHaulFile

public void setHaulFile(String haulFile)

getLengthFile
```
public String getLengthFile()
```

setLengthFile

public void setLengthFile(String lengthFile)

getStrataFile
```
public String getStrataFile()
```

setStrataFile

public void setStrataFile(String strataFile)

getCatchFileName
```
public String getCatchFileName()
```

setCatchFileName

public void setCatchFileName(String catchFileName)

getHaulFileName
```
public String getHaulFileName()
```

setHaulFileName

public void setHaulFileName(String haulFileName)

getLengthFileName
```
public String getLengthFileName()
```

setLengthFileName

public void setLengthFileName(String lengthFileName)

getStrataFileName
```
public String getStrataFileName()
```

setStrataFileName

public void setStrataFileName(String strataFileName)

setMaps
```
public void setMaps(List<File> maps)
```

getMaps
```
public List<File> getMaps()
```

getComment
```
public String getComment()
```

setComment

public void setComment(String comment)

getCreationDate
```
public Date getCreationDate()
```

setCreationDate

public void setCreationDate(Date creationDate)

getControl
```
public Control getControl()
```

setControl

public void setControl(Control control)

getSelections

public Map<String,Selection> getSelections()

setSelections

public void setSelections(Map<String,Selection> selections)

addSelections

public void addSelections(Selection selection)

getRefTaxSpecies
```
public DataStorage getRefTaxSpecies()
```

setRefTaxSpecies

public void setRefTaxSpecies(DataStorage refTaxSpecies)

getRefTaxSpeciesMap
```
public LinkedHashMap<String,String> getRefTaxSpeciesMap()
```
Recuperation de la map de cache code especes/visualisation utilisateur.

Returns:
refTax species map
Since:

1.3

setRefTaxSpeciesMap
```
public void setRefTaxSpeciesMap(LinkedHashMap<String,String> refTaxSpeciesMap)
```
Modification de la map de cache code especes/visualisation utilisateur.

Parameters:
refTaxSpeciesMap - new map
Since:

1.3

getDisplaySpeciesText
```
public String getDisplaySpeciesText(String speciesCode)
```
Retourne le nom de visualisation de l'espèce conformement à la configuration du projet.

Returns:
le label espece
Since:

1.3

getTypeEspeces
```
public DataStorage getTypeEspeces()
```

setTypeEspeces

public void setTypeEspeces(DataStorage typeEspeces)

getStorageSpeciesType

public SpeciesFieldType getStorageSpeciesType()

setStorageSpeciesType

public void setStorageSpeciesType(SpeciesFieldType storageSpeciesType)

getDisplaySpeciesType

public SpeciesFieldType getDisplaySpeciesType()

setDisplaySpeciesType

public void setDisplaySpeciesType(SpeciesFieldType displaySpeciesType)

getOutputSpeciesType

public SpeciesFieldType getOutputSpeciesType()

setOutputSpeciesType

public void setOutputSpeciesType(SpeciesFieldType outputSpeciesType)

clearData
```
public void clearData()
```
Force all container data clear to force free memory.

toProperties
```
public Properties toProperties()
```

fromProperties

public void fromProperties(Properties props,
                  File mapDirectory)

getDataStorageFileName
```
public String getDataStorageFileName(CoserConstants.Category category,
                            String suffix)
```
Retourne le nom de stockage d'un fichier de données suivant la categories de fichier demandé. Les fichiers sont stockés avec leurs noms originaux (sauf les fichiers de réference) donc il n'est pas fixe.

Parameters:
category - category to get file name
suffix - suffix to add into file name

Returns:
storage file name
Since:

1.5

Class Project

Field Summary

Fields inherited from class fr.ifremer.coser.bean.AbstractEntity

Constructor Summary

Method Summary

Methods inherited from class fr.ifremer.coser.bean.AbstractEntity

Methods inherited from class java.lang.Object

Field Detail

REFTAX_SPECIES_HEADER

TYPE_ESPECE_HEADER

PROPERTY_SELECTIONS

name

author

catchFile

haulFile

lengthFile

strataFile

catchFileName

haulFileName

lengthFileName

strataFileName

maps

comment

creationDate

control

selections

refTaxSpecies

refTaxSpeciesMap

typeEspeces

storageSpeciesType

displaySpeciesType

outputSpeciesType

Constructor Detail

Project

Project

Method Detail

getName

setName

getAuthor

setAuthor

getCatchFile

setCatchFile

getHaulFile

setHaulFile

getLengthFile

setLengthFile

getStrataFile

setStrataFile

getCatchFileName

setCatchFileName

getHaulFileName

setHaulFileName

getLengthFileName

setLengthFileName

getStrataFileName

setStrataFileName

setMaps

getMaps

getComment

setComment

getCreationDate

setCreationDate

getControl

setControl

getSelections

setSelections

addSelections

getRefTaxSpecies

setRefTaxSpecies

getRefTaxSpeciesMap

setRefTaxSpeciesMap

getDisplaySpeciesText

getTypeEspeces

setTypeEspeces

getStorageSpeciesType

setStorageSpeciesType

getDisplaySpeciesType

setDisplaySpeciesType

getOutputSpeciesType

setOutputSpeciesType