org.rvpf.document.exporter

Class XMLExporter

Object

XMLExporter

Direct Known Subclasses:

ConfigExporter, EntityExporter

public abstract class XMLExporter
extends Object

XML exporter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XMLExporter(Optional<ConfigExporter> owner) Creates an instance.

Method Summary

Modifier and Type	Method and Description
protected void	addExporter(Class<? extends Entity> entityClass) Adds this as the exporter for an Entity Class.
protected static boolean	areDeferredSubstitutions(Object[] values) Asks if all values are deferred substitutions.
protected XMLElement	createElement(String name) Creates an Element with the specified name.
protected Config	getConfig() Gets the config.
protected XMLDocument	getDocument() Gets the XML document.
protected abstract String	getElementName() Gets the XML element name.
protected Optional<? extends Entity>	getEntity(String name, String prefix) Gets an entity.
protected ConfigExporter	getOwner() Gets the owner.
protected EntityReference	getReference(Entity entity) Gets the Reference to an Entity.
protected XMLElement	getRootElement() Gets the root Element.
protected boolean	isWithAttributes() Asks if attributes are required.
protected boolean	isWithAttributes(String usage) Asks if attributes for the specified usage are required.
protected boolean	isWithTexts() Asks if texts are required.
protected boolean	isWithTexts(String lang) Asks if texts in the specified language are required.
protected int	nextId() Returns the next ID for attribution to an Entity.
protected Optional<String>	reference(Optional<? extends Entity> entity) Returns a reference string to an entity.
protected void	registerReference(Optional<? extends Entity> entity) Registers an entity.

Methods inherited from class Object

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

Constructor Detail

XMLExporter

protected XMLExporter(@Nonnull
                      Optional<ConfigExporter> owner)

Creates an instance.

Parameters:

owner - The optional exporter owning this.

Method Detail

areDeferredSubstitutions

@CheckReturnValue
protected static boolean areDeferredSubstitutions(@Nonnull
                                                                     Object[] values)

Asks if all values are deferred substitutions.

Parameters:

values - The values.

Returns:

True if all values are deferred substitutions.

addExporter

protected final void addExporter(@Nonnull
                                 Class<? extends Entity> entityClass)

Adds this as the exporter for an Entity Class.

Parameters:

entityClass - The Entity Class.

createElement

@Nonnull
 @CheckReturnValue
protected final XMLElement createElement(@Nonnull
                                                                       String name)

Creates an Element with the specified name.

Parameters:

name - The Element name.

Returns:

The Element.

getConfig

@Nonnull
 @CheckReturnValue
protected Config getConfig()

Gets the config.

Returns:

The config.

getDocument

@Nonnull
 @CheckReturnValue
protected XMLDocument getDocument()

Gets the XML document.

Returns:

The XML document.

getElementName

@Nonnull
 @CheckReturnValue
protected abstract String getElementName()

Gets the XML element name.

Returns:

The name.

getEntity

@Nonnull
 @CheckReturnValue
protected final Optional<? extends Entity> getEntity(@Nonnull
                                                                                   String name,
                                                                                   @Nonnull
                                                                                   String prefix)

Gets an entity.

Parameters:

name - The name of the entity.

prefix - The prefix associated with the class of the entity.

Returns:

The optional entity.

getOwner

@Nonnull
 @CheckReturnValue
protected ConfigExporter getOwner()

Gets the owner.

Returns:

The owner.

getReference

@Nonnull
 @CheckReturnValue
protected final EntityReference getReference(@Nonnull
                                                                           Entity entity)

Gets the Reference to an Entity.

Parameters:

entity - The referenced Entity.

Returns:

The Reference.

getRootElement

@Nonnull
 @CheckReturnValue
protected XMLElement getRootElement()

Gets the root Element.

Returns:

The root Element.

isWithAttributes

@CheckReturnValue
protected final boolean isWithAttributes()

Asks if attributes are required.

Returns:

True when attributes are required.

isWithAttributes

@CheckReturnValue
protected final boolean isWithAttributes(@Nonnull
                                                            String usage)

Asks if attributes for the specified usage are required.

Parameters:

usage - The attributes usage.

Returns:

True when they are required.

isWithTexts

@CheckReturnValue
protected final boolean isWithTexts()

Asks if texts are required.

Returns:

True when texts are required.

isWithTexts

@CheckReturnValue
protected final boolean isWithTexts(String lang)

Asks if texts in the specified language are required.

Parameters:

lang - The texts language.

Returns:

True when they are required.

nextId

@CheckReturnValue
protected int nextId()

Returns the next ID for attribution to an Entity.

Returns:

A new Entity ID.

reference

@Nonnull
 @CheckReturnValue
protected Optional<String> reference(@Nonnull
                                                                   Optional<? extends Entity> entity)

Returns a reference string to an entity.

Parameters:

entity - The optional entity.

Returns:

The optional reference string.

registerReference

protected void registerReference(@Nonnull
                                 Optional<? extends Entity> entity)

Registers an entity.

Parameters:

entity - The entity to register.