org.rvpf.document.loader

Class MetadataDocumentLoader

Object

DocumentLoader

ConfigDocumentLoader

MetadataDocumentLoader

All Implemented Interfaces:

PropertyChangeListener, EventListener, XMLElement.Factory

public final class MetadataDocumentLoader
extends ConfigDocumentLoader

Metadata document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MetadataDocumentLoader.MetadataHandler MetadataHandler.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PATH Default source of metadata XML text.
static String	METADATA_PROPERTIES Properties holding the metadata configuration.
static String	METADATA_ROOT Root element of metadata XML text.
static String	PATH_PROPERTY Property holding the path to the metadata XML text.

Fields inherited from class ConfigDocumentLoader

CONFIG_PROPERTY, CONFIG_ROOT, DEFAULT_CONFIG, DOCTYPE_STRINGS, VALIDATION_DISABLED_PROPERTY, VALIDATION_ENABLED_PROPERTY

Fields inherited from class DocumentLoader

ID_PATTERN, ID_PREFIX

Method Summary

Modifier and Type	Method and Description
static Metadata	fetchMetadata(MetadataFilter filter, Optional<Config> config, Optional<UUID> uuid, Optional<String> from) Fetches the Metadata.
protected DocumentLoader.RootHandler	getRootHandler() Gets a root handler.
protected URL	getURL() Gets the URL for this document.
protected boolean	loadFrom(String from, Optional<Reader> reader) Loads this document from the specified location with a supplied reader.
protected boolean	read(String xml) Reads the document from an XML string.

Methods inherited from class ConfigDocumentLoader

getRootName, loadConfig, propertyChange, setURL

Methods inherited from class DocumentLoader

addPrefixNames, getEntity, getPrefixName, getThisLogger, handle, newXMLElement, setEntities, setSubstitutionDeferred, setSubstitutionEnabled, setValidating

Methods inherited from class Object

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

Field Detail

DEFAULT_PATH

public static final String DEFAULT_PATH

Default source of metadata XML text.

See Also:

Constant Field Values

METADATA_PROPERTIES

public static final String METADATA_PROPERTIES

Properties holding the metadata configuration.

See Also:

Constant Field Values

METADATA_ROOT

public static final String METADATA_ROOT

Root element of metadata XML text.

See Also:

Constant Field Values

PATH_PROPERTY

public static final String PATH_PROPERTY

Property holding the path to the metadata XML text.

See Also:

Constant Field Values

Method Detail

fetchMetadata

@Nullable
 @CheckReturnValue
public static Metadata fetchMetadata(@Nonnull
                                                                    MetadataFilter filter,
                                                                    @Nonnull
                                                                    Optional<Config> config,
                                                                    @Nonnull
                                                                    Optional<UUID> uuid,
                                                                    @Nonnull
                                                                    Optional<String> from)

Fetches the Metadata.

Parameters:

filter - A metadata filter.

config - The optional config.

uuid - The optional UUID for the metadata cache.

from - The optional location to load from.

Returns:

The metadata (null on failure).

getRootHandler

protected DocumentLoader.RootHandler getRootHandler()

Gets a root handler.

Overrides:

getRootHandler in class ConfigDocumentLoader

Returns:

A root handler.

getURL

protected URL getURL()

Gets the URL for this document.

Overrides:

getURL in class ConfigDocumentLoader

Returns:

The URL.

loadFrom

protected boolean loadFrom(String from,
                           Optional<Reader> reader)

Loads this document from the specified location with a supplied reader.

Overrides:

loadFrom in class ConfigDocumentLoader

Parameters:

from - The location to load from.

reader - The optional reader.

Returns:

True on success.

read

protected boolean read(String xml)

Reads the document from an XML string.

Overrides:

read in class ConfigDocumentLoader

Parameters:

xml - The XML string.

Returns:

True on success.