org.rvpf.clock

Class ClockMetadataFilter

Object

MetadataFilter

ClockMetadataFilter

All Implemented Interfaces:

Cloneable

public final class ClockMetadataFilter
extends MetadataFilter

Clock 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

Method Summary

Modifier and Type	Method and Description
boolean	areContentsNeeded() Asks if the contents are needed.
boolean	areOriginsFiltered() Asks if the origins are filtered.
boolean	areOriginsNeeded() Asks if the origins are needed.
boolean	areStoresNeeded() Asks if the stores are needed.
Optional<String>	getClientIdent() Gets a client identification.
Optional<OriginEntity>	getOriginEntity() Gets the origin Entity.
String	getOriginName() Gets the origin name.
protected void	includeOriginsXML(XMLElement root) Includes origins request XML if needed.
boolean	isOriginNeeded(OriginEntity originEntity) Asks if an origin is needed.
boolean	isPointNeeded(PointEntity pointEntity) Asks if a point is needed.
void	reset() Resets to pristine state.

Methods inherited from class MetadataFilter

areAttributesNeeded, areAttributesNeeded, areBehaviorsNeeded, areContentsRequired, areEnginesFiltered, areEnginesNeeded, areEntitiesKept, areGroupsNeeded, areOriginsRequired, arePermissionsNeeded, arePointInputsFlagged, arePointInputsNeeded, arePointInputsNeeded, arePointReplicatesNeeded, arePointsNeeded, areStoresFiltered, areStoresRequired, areSyncsNeeded, areTextsNeeded, areTransformsNeeded, areTransformsRequired, callBack, clone, getXML, includeAttributesXML, includeContentsXML, includeEnginesXML, includeGroupsXML, includeInputsXML, includePointsXML, includeReplicatesXML, includeResultsXML, includeStoresXML, includeSyncsXML, includeTextsXML, includeTransformsXML, isEngineNeeded, isPointTransformNeeded, isStoreNeeded, tidy, toString

Methods inherited from class Object

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

Method Detail

areContentsNeeded

public boolean areContentsNeeded()

Asks if the contents are needed.

Overrides:

areContentsNeeded in class MetadataFilter

Returns:

True if the contents are needed.

areOriginsFiltered

public boolean areOriginsFiltered()

Asks if the origins are filtered.

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

Overrides:

areOriginsFiltered in class MetadataFilter

Returns:

True if the origins are filtered.

areOriginsNeeded

public boolean areOriginsNeeded()

Asks if the origins are needed.

Overrides:

areOriginsNeeded in class MetadataFilter

Returns:

True if the origins are needed.

areStoresNeeded

public boolean areStoresNeeded()

Asks if the stores are needed.

Overrides:

areStoresNeeded in class MetadataFilter

Returns:

True if the stores are needed.

getClientIdent

public Optional<String> getClientIdent()

Gets a client identification.

Overrides:

getClientIdent in class MetadataFilter

Returns:

The optional client ident.

getOriginEntity

@Nonnull
 @CheckReturnValue
public Optional<OriginEntity> getOriginEntity()

Gets the origin Entity.

Returns:

The optional origin Entity.

getOriginName

@Nonnull
 @CheckReturnValue
public String getOriginName()

Gets the origin name.

Returns:

The origin name.

isOriginNeeded

public boolean isOriginNeeded(OriginEntity originEntity)

Asks if an origin is needed.

Overrides:

isOriginNeeded in class MetadataFilter

Parameters:

originEntity - The origin entity.

Returns:

True if the origin is needed.

isPointNeeded

public boolean isPointNeeded(PointEntity pointEntity)

Asks if a point is needed.

Overrides:

isPointNeeded in class MetadataFilter

Parameters:

pointEntity - The point entity.

Returns:

True if the point is needed.

reset

public void reset()

Resets to pristine state.

Note: when overriding, call super last to complete reset.

Overrides:

reset in class MetadataFilter

includeOriginsXML

protected void includeOriginsXML(XMLElement root)

Includes origins request XML if needed.

Overrides:

includeOriginsXML in class MetadataFilter

Parameters:

root - The root of the XML being built.