public class ExportScheme extends Object implements Serializable
Constructor and Description |
---|
ExportScheme(String name,
boolean editable,
ArrayList<String> sectionList,
HashMap<String,ArrayList<ExportFeature>> exportFeatures,
String separator,
boolean indexes,
boolean header,
int separationLines,
boolean includeSectionTitles,
boolean validatedOnly,
boolean includeDecoys)
Constructor.
|
ExportScheme(String name,
boolean editable,
HashMap<String,ArrayList<ExportFeature>> exportFeatures,
String separator,
boolean indexes,
boolean header,
int separationLines,
boolean includeSectionTitles,
boolean validatedOnly,
boolean includeDecoys)
Constructor.
|
ExportScheme(String name,
boolean editable,
HashMap<String,ArrayList<ExportFeature>> exportFeatures,
String separator,
boolean indexes,
boolean header,
int separationLines,
boolean includeSectionTitles,
boolean validatedOnly,
boolean includeDecoys,
String mainTitle)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addExportFeature(String section,
ExportFeature exportFeature)
Adds an export feature to the desired section.
|
ArrayList<ExportFeature> |
getExportFeatures(String section)
Returns the export features to be included in the given section.
|
String |
getMainTitle()
Returns the main title of the report.
|
String |
getName()
Returns the name of the scheme.
|
ArrayList<String> |
getSections()
returns the list of sections to be included in the scheme.
|
int |
getSeparationLines()
Returns the number of lines to be used to separate the sections.
|
String |
getSeparator()
Returns the column separator.
|
boolean |
isEditable()
Indicates whether the scheme is editable.
|
boolean |
isHeader()
Indicates whether column header shall be used.
|
Boolean |
isIncludeDecoy()
Indicates whether decoy hits should be included.
|
boolean |
isIncludeSectionTitles()
Indicates whether section titles shall be used.
|
boolean |
isIndexes()
Indicates whether lines shall be indexed.
|
Boolean |
isValidatedOnly()
Indicates whether only validated results should be exported.
|
void |
removeSection(String sectionName)
Removes an entire section from the mapping.
|
void |
setEditable(boolean editable)
Sets whether the scheme is editable.
|
void |
setExportFeatures(String section,
ArrayList<ExportFeature> exportFeatures)
Sets the export features of a given section.
|
void |
setIncludeDecoy(Boolean includeDecoy)
Sets whether decoy hits should be included.
|
void |
setName(String name)
Sets the name of the scheme.
|
void |
setValidatedOnly(Boolean validatedOnly)
Sets whether only validated results should be exported.
|
public ExportScheme(String name, boolean editable, HashMap<String,ArrayList<ExportFeature>> exportFeatures, String separator, boolean indexes, boolean header, int separationLines, boolean includeSectionTitles, boolean validatedOnly, boolean includeDecoys, String mainTitle)
name
- the name of the schemeeditable
- a boolean indicating whether the scheme can be edited by
the userexportFeatures
- list of features to be included in the reportseparator
- the column separator to be usedindexes
- indicates whether lines shall be indexedheader
- indicates whether column headers shall be includedseparationLines
- the number of lines to use for section separationincludeSectionTitles
- indicates whether section titles shall be
usedmainTitle
- the title of the reportvalidatedOnly
- Indicates whether only validated matches should be
includedincludeDecoys
- Indicates whether decoy matches should be includedpublic ExportScheme(String name, boolean editable, ArrayList<String> sectionList, HashMap<String,ArrayList<ExportFeature>> exportFeatures, String separator, boolean indexes, boolean header, int separationLines, boolean includeSectionTitles, boolean validatedOnly, boolean includeDecoys)
name
- the name of the schemeeditable
- a boolean indicating whether the scheme can be edited by
the usersectionList
- ordered list of the sections included in the reportexportFeatures
- list of features to be included in the reportseparator
- the column separator to be usedindexes
- indicates whether lines shall be indexedheader
- indicates whether column headers shall be includedseparationLines
- the number of lines to use for section separationincludeSectionTitles
- indicates whether section titles shall be
usedvalidatedOnly
- Indicates whether only validated matches should be
includedincludeDecoys
- Indicates whether decoy matches should be includedpublic ExportScheme(String name, boolean editable, HashMap<String,ArrayList<ExportFeature>> exportFeatures, String separator, boolean indexes, boolean header, int separationLines, boolean includeSectionTitles, boolean validatedOnly, boolean includeDecoys)
name
- the name of the schemeeditable
- a boolean indicating whether the scheme can be edited by
the userexportFeatures
- list of features to be included in the reportseparator
- the column separator to be usedindexes
- indicates whether lines shall be indexedheader
- indicates whether column headers shall be includedseparationLines
- the number of lines to use for section separationincludeSectionTitles
- indicates whether section titles shall be
usedvalidatedOnly
- Indicates whether only validated matches should be
includedincludeDecoys
- Indicates whether decoy matches should be includedpublic String getSeparator()
public boolean isIndexes()
public boolean isHeader()
public int getSeparationLines()
public boolean isIncludeSectionTitles()
public ArrayList<String> getSections()
public ArrayList<ExportFeature> getExportFeatures(String section)
section
- the section of interestpublic void setExportFeatures(String section, ArrayList<ExportFeature> exportFeatures)
section
- the name of the sectionexportFeatures
- the export features to include in that sectionpublic void addExportFeature(String section, ExportFeature exportFeature)
section
- the name of the sectionexportFeature
- the export feature to addpublic void removeSection(String sectionName)
sectionName
- the section namepublic String getMainTitle()
public String getName()
public void setName(String name)
name
- the name of the schemepublic boolean isEditable()
public void setEditable(boolean editable)
editable
- a boolean indicating whether the scheme shall be editablepublic Boolean isValidatedOnly()
public void setValidatedOnly(Boolean validatedOnly)
validatedOnly
- whether only validated results should be exportedpublic Boolean isIncludeDecoy()
public void setIncludeDecoy(Boolean includeDecoy)
includeDecoy
- whether decoy hits should be includedCopyright © 2016. All rights reserved.