uk.ac.ed.epcc.webapp.model.data

Class Dumper

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

uk.ac.ed.epcc.webapp.model.data.Dumper

All Implemented Interfaces:

Contexed

public class Dumper
extends AbstractContexed

Class to dump DataObjects to files. Mostly this works at the Repository level If field renaming is in place the dump used the database field not the tag used by the code. This allows tests to be written with renames in place. The dump parser will look for a renamed field if it can't find the code-tag. Note that undump creates a table using the normal code so if renames are applied duringtable creation an undump can generate a renamed repository References are followed and the dependencies dumped in a depth-first order as well so that self-consistant subsets of data can be extracted. polymorphic reference fields (which can point to multiple tables) and reference fields that do not have their peer table set in a foreign key or config parameter cannot be followed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLOB_TYPE
static java.lang.String	BOOLEAN_TYPE
static java.lang.String	COLUMN
static java.lang.String	DATE_TYPE
static java.lang.String	DEFAULT_ATTR
static java.lang.String	DELETED_ATTR
static java.lang.String	DOUBLE_TYPE
static java.lang.String	FLOAT_TYPE
static java.lang.String	FULLTEXT_INDEX_TYPE
static java.lang.String	ID
static java.lang.String	INDEX_TYPE
static java.lang.String	INTEGER_TYPE
static java.lang.String	LONG_TYPE
static java.lang.String	MAX_ATTR
static java.lang.String	NAME_ATTR
static java.lang.String	NULL_VALUE_ATTR
static java.lang.String	NULLABLE_ATTR
static java.lang.String	REFERENCE_ATTR
static java.lang.String	STRING_TYPE
static java.lang.String	TABLE_SPECIFICATION
static java.lang.String	TYPE_ATTR
static java.lang.String	UNIQUE_ATTR

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
Dumper(AppContext conn, SimpleXMLBuilder builder)

Method Summary

Modifier and Type	Method and Description
void	addSpecification(java.lang.String tag, TableSpecification spec)
boolean	beenSeen(java.lang.String tag, int id) Has a specified record already been processed.
void	dump(DataObject obj)
protected void	dump(Repository.Record rec)
void	dumpAll(Repository res)
protected boolean	dumpDiff(Repository.Record rec, Repository.Record baseline)
boolean	dumpNullValues()
void	dumpSchema(Repository res)
void	markSeen(java.lang.String tag, int id) Mark a record as "seen" so it will be excluded if encountered in the dump process.
java.lang.String	normaliseTag(java.lang.String tag)
void	setDumpNullValues(boolean dump)
void	setVerboseDiff(boolean verbose_diff)
boolean	verboseDiff()

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Field Detail

DELETED_ATTR

public static final java.lang.String DELETED_ATTR

See Also:

Constant Field Values

COLUMN

public static final java.lang.String COLUMN

See Also:

Constant Field Values

DOUBLE_TYPE

public static final java.lang.String DOUBLE_TYPE

See Also:

Constant Field Values

FLOAT_TYPE

public static final java.lang.String FLOAT_TYPE

See Also:

Constant Field Values

LONG_TYPE

public static final java.lang.String LONG_TYPE

See Also:

Constant Field Values

INTEGER_TYPE

public static final java.lang.String INTEGER_TYPE

See Also:

Constant Field Values

DATE_TYPE

public static final java.lang.String DATE_TYPE

See Also:

Constant Field Values

BOOLEAN_TYPE

public static final java.lang.String BOOLEAN_TYPE

See Also:

Constant Field Values

STRING_TYPE

public static final java.lang.String STRING_TYPE

See Also:

Constant Field Values

BLOB_TYPE

public static final java.lang.String BLOB_TYPE

See Also:

Constant Field Values

INDEX_TYPE

public static final java.lang.String INDEX_TYPE

See Also:

Constant Field Values

FULLTEXT_INDEX_TYPE

public static final java.lang.String FULLTEXT_INDEX_TYPE

See Also:

Constant Field Values

REFERENCE_ATTR

public static final java.lang.String REFERENCE_ATTR

See Also:

Constant Field Values

DEFAULT_ATTR

public static final java.lang.String DEFAULT_ATTR

See Also:

Constant Field Values

TYPE_ATTR

public static final java.lang.String TYPE_ATTR

See Also:

Constant Field Values

MAX_ATTR

public static final java.lang.String MAX_ATTR

See Also:

Constant Field Values

NULLABLE_ATTR

public static final java.lang.String NULLABLE_ATTR

See Also:

Constant Field Values

UNIQUE_ATTR

public static final java.lang.String UNIQUE_ATTR

See Also:

Constant Field Values

NAME_ATTR

public static final java.lang.String NAME_ATTR

See Also:

Constant Field Values

NULL_VALUE_ATTR

public static final java.lang.String NULL_VALUE_ATTR

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

TABLE_SPECIFICATION

public static final java.lang.String TABLE_SPECIFICATION

See Also:

Constant Field Values

Constructor Detail

Dumper

public Dumper(AppContext conn,
              SimpleXMLBuilder builder)

Method Detail

dump

public void dump(DataObject obj)
          throws DataFault,
                 java.io.IOException

Throws:

DataFault

java.io.IOException

addSpecification

public void addSpecification(java.lang.String tag,
                             TableSpecification spec)

beenSeen

public boolean beenSeen(java.lang.String tag,
                        int id)

Has a specified record already been processed.

Parameters:

tag -

id -

Returns:

markSeen

public void markSeen(java.lang.String tag,
                     int id)

Mark a record as "seen" so it will be excluded if encountered in the dump process.

Parameters:

tag -

id -

dump

protected void dump(Repository.Record rec)
             throws DataFault,
                    java.io.IOException

Throws:

DataFault

java.io.IOException

dumpDiff

protected boolean dumpDiff(Repository.Record rec,
                           Repository.Record baseline)
                    throws DataFault,
                           java.io.IOException

Throws:

DataFault

java.io.IOException

dumpAll

public void dumpAll(Repository res)
             throws ConsistencyError,
                    DataException,
                    java.io.IOException

Throws:

ConsistencyError

DataException

java.io.IOException

dumpSchema

public void dumpSchema(Repository res)

dumpNullValues

public boolean dumpNullValues()

Returns:

the dump_null_values

setDumpNullValues

public void setDumpNullValues(boolean dump)

verboseDiff

public boolean verboseDiff()

Returns:

the verbose_diff

setVerboseDiff

public void setVerboseDiff(boolean verbose_diff)

Parameters:

verbose_diff - the verbose_diff to set

normaliseTag

public java.lang.String normaliseTag(java.lang.String tag)