Package psidev.psi.mi.jami.html

Class MIHtmlOptionFactory

java.lang.Object

psidev.psi.mi.jami.html.MIHtmlOptionFactory

public class MIHtmlOptionFactory
extends Object

The factory to populate the map of options for the InteractionWriterFactory for html writers

Since:

03/07/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getDefaultHtmlOptions(File outputFile)	Create the options for a HTML interaction writer.
Map<String,Object>	getDefaultHtmlOptions(OutputStream output)	Create the options for a HTML interaction writer.
Map<String,Object>	getDefaultHtmlOptions(Writer writer)	Create the options for a Html interaction writer.
Map<String,Object>	getHtmlOptions(boolean writeHeader, File outputFile)	Create the options for a HTML interaction writer.
Map<String,Object>	getHtmlOptions(boolean writeHeader, OutputStream output)	Create the options for a HTML interaction writer.
Map<String,Object>	getHtmlOptions(boolean writeHeader, Writer writer)	Create the options for a HTML interaction writer.
Map<String,Object>	getHtmlOptions(Object output, InteractionCategory objectCategory, boolean writeHeader)	Create the options for the HTML InteractionWriter.
Map<String,Object>	getHtmlOptions(InteractionCategory objectCategory, File outputFile)	Create the options for a HTML interaction writer.
Map<String,Object>	getHtmlOptions(InteractionCategory objectCategory, OutputStream output)	Create the options for a HTML interaction writer.
Map<String,Object>	getHtmlOptions(InteractionCategory objectCategory, Writer writer)	Create the options for a HTML interaction writer.
static MIHtmlOptionFactory	getInstance()	Getter for the field instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MIHtmlOptionFactory getInstance()

Getter for the field instance.

Returns:

a MIHtmlOptionFactory object.

getDefaultHtmlOptions

public Map<String,Object> getDefaultHtmlOptions(File outputFile)

Create the options for a HTML interaction writer.

Parameters:

outputFile - : the file where to write the interactions

Returns:

the options for the HTML InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(InteractionCategory objectCategory,
                                               File outputFile)

Create the options for a HTML interaction writer.

Parameters:

objectCategory - : the interaction object type to write

outputFile - : the file where to write the interactions

Returns:

the options for the HTML InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(boolean writeHeader,
                                               File outputFile)

Create the options for a HTML interaction writer.

Parameters:

writeHeader - : true if we want to write the header

outputFile - : the file where to write the interactions

Returns:

the options for a HTML interaction writer.

getDefaultHtmlOptions

public Map<String,Object> getDefaultHtmlOptions(OutputStream output)

Create the options for a HTML interaction writer.

Parameters:

output - : the output

Returns:

the options for the HTML InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(InteractionCategory objectCategory,
                                               OutputStream output)

Create the options for a HTML interaction writer.

Parameters:

objectCategory - : the interaction object type to write

output - : the output

Returns:

the options for the HTML InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(boolean writeHeader,
                                               OutputStream output)

Create the options for a HTML interaction writer.

Parameters:

writeHeader - : true if we want to write the header

output - : the outputstream

Returns:

the options for a HTML interaction writer.

getDefaultHtmlOptions

public Map<String,Object> getDefaultHtmlOptions(Writer writer)

Create the options for a Html interaction writer.

Parameters:

writer - : the writer

Returns:

the options for the Html InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(InteractionCategory objectCategory,
                                               Writer writer)

Create the options for a HTML interaction writer.

Parameters:

objectCategory - : the interaction object type to write

writer - : the writer

Returns:

the options for the HTML InteractionWriter

getHtmlOptions

public Map<String,Object> getHtmlOptions(boolean writeHeader,
                                               Writer writer)

Create the options for a HTML interaction writer.

Parameters:

writeHeader - : true if we want to write the header

writer - : the writer

Returns:

the options for a HTML interaction writer.

getHtmlOptions

public Map<String,Object> getHtmlOptions(Object output,
                                               InteractionCategory objectCategory,
                                               boolean writeHeader)

Create the options for the HTML InteractionWriter.

Parameters:

output - a Object object.

objectCategory - : the interaction object type to write

writeHeader - : true if we want to write the header/body

Returns:

the options for the HTML InteractionWriter