Package se.conciliate.extensions.xml

Interface RepositoryXMLWriter

public interface RepositoryXMLWriter

Serializes repository data to XML that can later be read using a RepositoryXMLReader.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HINT_CHANGED_TIMESTAMP	A hint for the time to compare to to set the "changed" flag of entities in the export file.
static final String	HINT_WRITE_EXTENSION_DOCUMENTS
static final String	HINT_WRITE_PLUGIN_DATA
static final String	VALUE_WRITE_EXTENSION_DOCUMENTS_FALSE
static final String	VALUE_WRITE_EXTENSION_DOCUMENTS_TRUE
static final String	VALUE_WRITE_PLUGIN_DATA_FALSE
static final String	VALUE_WRITE_PLUGIN_DATA_TRUE

Method Summary

Modifier and Type	Method	Description
String	getNamespaceURI()	Returns the namespace URI for the XML format.
<T> InputStream	getSchema(Class<T> type)	Returns the schema resource for an entity type.
void	setHint(String hint, Object value)	Sets a hint for the writer.
<T> void	writeEntity(XMLStreamWriter writer, Class<T> type, T entity)	Writes an entity to XML.

Field Details

HINT_WRITE_PLUGIN_DATA

static final String HINT_WRITE_PLUGIN_DATA

See Also:

• Constant Field Values

VALUE_WRITE_PLUGIN_DATA_TRUE

static final String VALUE_WRITE_PLUGIN_DATA_TRUE

See Also:

• Constant Field Values

VALUE_WRITE_PLUGIN_DATA_FALSE

static final String VALUE_WRITE_PLUGIN_DATA_FALSE

See Also:

• Constant Field Values

HINT_WRITE_EXTENSION_DOCUMENTS

static final String HINT_WRITE_EXTENSION_DOCUMENTS

See Also:

• Constant Field Values

VALUE_WRITE_EXTENSION_DOCUMENTS_TRUE

static final String VALUE_WRITE_EXTENSION_DOCUMENTS_TRUE

See Also:

• Constant Field Values

VALUE_WRITE_EXTENSION_DOCUMENTS_FALSE

static final String VALUE_WRITE_EXTENSION_DOCUMENTS_FALSE

See Also:

• Constant Field Values

HINT_CHANGED_TIMESTAMP

static final String HINT_CHANGED_TIMESTAMP

A hint for the time to compare to to set the "changed" flag of entities in the export file. Set the value to a MTTimestamp. Entities that are not changed after the timestamp will be marked as not changed in the export file.

See Also:

• Constant Field Values

Method Details

getNamespaceURI

String getNamespaceURI()

Returns the namespace URI for the XML format.

Returns:

The namespace URI.

getSchema

<T> InputStream getSchema(Class<T> type)

Returns the schema resource for an entity type.

Returns:

The schema as an input stream.

writeEntity

<T> void writeEntity(XMLStreamWriter writer,
 Class<T> type,
 T entity)
              throws XMLStreamException

Writes an entity to XML.

Parameters:

writer - The XML writer to write to.

type - The type of entity to write.

entity - The entity to write.

Throws:

XMLStreamException

setHint

void setHint(String hint,
 Object value)

Sets a hint for the writer.