org.biojava.bio.structure.align.util
Class UserConfiguration

java.lang.Object
  org.biojava.bio.structure.align.util.UserConfiguration

public class UserConfiguration
extends java.lang.Object

A container to persist config to the file system

Author:

Andreas Prlic

Field Summary

static java.lang.String	MMCIF_FORMAT
static java.lang.String	PDB_DIR
static java.lang.String	PDB_FORMAT
static java.lang.String	TMP_DIR

Constructor Summary

UserConfiguration()
Default UserConfiguration: split directory autofetch files default download location.

Method Summary

static UserConfiguration	fromStartupParams(StartupParameters params)
boolean	getAutoFetch()
java.lang.String	getFileFormat()
java.lang.String	getPdbFilePath()
boolean	isSplit()
void	setAutoFetch(boolean autoFetch)
void	setFileFormat(java.lang.String fileFormat)
void	setPdbFilePath(java.lang.String pdbFilePath)
void	setSplit(boolean isSplit)
XMLWriter	toXML(java.io.PrintWriter pw) convert Configuration to an XML file so it can be serialized
XMLWriter	toXML(XMLWriter xw) convert Configuration to an XML file so it can be serialized add to an already existing xml file.

Methods inherited from class java.lang.Object

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

Field Detail

PDB_FORMAT

public static final java.lang.String PDB_FORMAT

See Also:

Constant Field Values

MMCIF_FORMAT

public static final java.lang.String MMCIF_FORMAT

See Also:

Constant Field Values

TMP_DIR

public static final java.lang.String TMP_DIR

See Also:

Constant Field Values

PDB_DIR

public static final java.lang.String PDB_DIR

See Also:

Constant Field Values

Constructor Detail

UserConfiguration

public UserConfiguration()

Default UserConfiguration:

• split directory
• autofetch files
• default download location. This is the first specified of:
  1. PDB_DIR system property (for instance, -DPDB_DIR=/tmp)
  2. PDB_DIR environment variable
  3. System temp directory (java.io.tmpdir property)

Method Detail

getPdbFilePath

public java.lang.String getPdbFilePath()

setPdbFilePath

public void setPdbFilePath(java.lang.String pdbFilePath)

isSplit

public boolean isSplit()

setSplit

public void setSplit(boolean isSplit)

getAutoFetch

public boolean getAutoFetch()

setAutoFetch

public void setAutoFetch(boolean autoFetch)

toXML

public XMLWriter toXML(java.io.PrintWriter pw)
                throws java.io.IOException

convert Configuration to an XML file so it can be serialized

Parameters:

pw -

Returns:

XMLWriter

Throws:

java.io.IOException

toXML

public XMLWriter toXML(XMLWriter xw)
                throws java.io.IOException

convert Configuration to an XML file so it can be serialized add to an already existing xml file.

Parameters:

xw - the XML writer to use

Returns:

the writer again

Throws:

java.io.IOException

fromStartupParams

public static UserConfiguration fromStartupParams(StartupParameters params)

setFileFormat

public void setFileFormat(java.lang.String fileFormat)

getFileFormat

public java.lang.String getFileFormat()