org.rvpf.http.rpn

Class RPNMetadataFilter

Object

MetadataFilter

RPNMetadataFilter

All Implemented Interfaces:

Cloneable

public final class RPNMetadataFilter
extends MetadataFilter

RPN metadata filter.

Field Summary

Fields inherited from class MetadataFilter

AFTER_ATTRIBUTE, ATTRIBUTES_ELEMENT, CONTENTS_ELEMENT, DOMAIN_ATTRIBUTE, ENGINE_ATTRIBUTE, ENGINE_ELEMENT, ENGINES_ELEMENT, GET_METADATA_ROOT, GROUP_ELEMENT, GROUPS_ELEMENT, INPUTS_ELEMENT, ORIGIN_ATTRIBUTE, ORIGIN_ELEMENT, ORIGINS_ELEMENT, POINTS_ELEMENT, PROPERTIES_ELEMENT, REPLICATES_ELEMENT, RESULTS_ELEMENT, STORE_ATTRIBUTE, STORE_ELEMENT, STORES_ELEMENT, SYNCS_ELEMENT, TEXTS_ELEMENT, TRANSFORMS_ELEMENT

Constructor Summary

Constructors

Constructor and Description
RPNMetadataFilter(String engineName) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	areContentsNeeded() Asks if the contents are needed.
boolean	areEnginesFiltered() Asks if the engines are filtered.
boolean	areEnginesNeeded() Asks if the engines are needed.
boolean	areEntitiesKept() Asks if the entities should be kept.
boolean	arePointsNeeded() Asks if any point is needed.
boolean	areTransformsNeeded() Asks if the transforms are needed.
Optional<String>	getClientIdent() Gets a client identification.
String	getEngineName() Gets the engine name.
protected void	includeEnginesXML(XMLElement root) Includes engines request XML if needed.
boolean	isEngineNeeded(EngineEntity engineEntity) Asks if an engine is needed.

Methods inherited from class MetadataFilter

areAttributesNeeded, areAttributesNeeded, areBehaviorsNeeded, areContentsRequired, areGroupsNeeded, areOriginsFiltered, areOriginsNeeded, areOriginsRequired, arePermissionsNeeded, arePointInputsFlagged, arePointInputsNeeded, arePointInputsNeeded, arePointReplicatesNeeded, areStoresFiltered, areStoresNeeded, areStoresRequired, areSyncsNeeded, areTextsNeeded, areTransformsRequired, callBack, clone, getXML, includeAttributesXML, includeContentsXML, includeGroupsXML, includeInputsXML, includeOriginsXML, includePointsXML, includeReplicatesXML, includeResultsXML, includeStoresXML, includeSyncsXML, includeTextsXML, includeTransformsXML, isOriginNeeded, isPointNeeded, isPointTransformNeeded, isStoreNeeded, reset, tidy, toString

Methods inherited from class Object

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

Constructor Detail

RPNMetadataFilter

public RPNMetadataFilter(@Nonnull
                         String engineName)

Constructs an instance.

Parameters:

engineName - The engine name.

Method Detail

areContentsNeeded

public boolean areContentsNeeded()

Asks if the contents are needed.

Overrides:

areContentsNeeded in class MetadataFilter

Returns:

True if the contents are needed.

areEnginesFiltered

public boolean areEnginesFiltered()

Asks if the engines are filtered.

This would be the case if MetadataFilter.isEngineNeeded(org.rvpf.metadata.entity.EngineEntity) does not always return true.

Overrides:

areEnginesFiltered in class MetadataFilter

Returns:

True if the engines are filtered.

areEnginesNeeded

public boolean areEnginesNeeded()

Asks if the engines are needed.

Overrides:

areEnginesNeeded in class MetadataFilter

Returns:

True if the engines are needed.

areEntitiesKept

public boolean areEntitiesKept()

Asks if the entities should be kept.

Overrides:

areEntitiesKept in class MetadataFilter

Returns:

True if the entities should be kept.

arePointsNeeded

public boolean arePointsNeeded()

Asks if any point is needed.

Overrides:

arePointsNeeded in class MetadataFilter

Returns:

True if any point is needed.

areTransformsNeeded

public boolean areTransformsNeeded()

Asks if the transforms are needed.

Overrides:

areTransformsNeeded in class MetadataFilter

Returns:

True if the transforms are needed.

getClientIdent

public Optional<String> getClientIdent()

Gets a client identification.

Overrides:

getClientIdent in class MetadataFilter

Returns:

The optional client ident.

getEngineName

@Nonnull
 @CheckReturnValue
public String getEngineName()

Gets the engine name.

Returns:

The engine name.

isEngineNeeded

public boolean isEngineNeeded(EngineEntity engineEntity)

Asks if an engine is needed.

Overrides:

isEngineNeeded in class MetadataFilter

Parameters:

engineEntity - The engine entity.

Returns:

True if the engine is needed.

includeEnginesXML

protected void includeEnginesXML(XMLElement root)

Includes engines request XML if needed.

Overrides:

includeEnginesXML in class MetadataFilter

Parameters:

root - The root of the XML being built.