MetadataFilter (RVPF-Core API Documentation)

Object
- MetadataFilter

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ClockMetadataFilter, MetadataServerFilter, RPNMetadataFilter, StoreMetadataFilter
```
@ThreadSafe
public class MetadataFilter
extends Object
implements Cloneable
```
Metadata filter.
A subclass of this class is used to filter the content of the metadata for a process. When a metadata document is read, the appropriate element loader calls these methods to decide if the entity just built should be included in the process metadata.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AFTER_ATTRIBUTE` After attribute.
`static String`	`ATTRIBUTES_ELEMENT` Attributes element.
`static String`	`CONTENTS_ELEMENT` Contents element.
`static String`	`DOMAIN_ATTRIBUTE` Domain attribute.
`static String`	`ENGINE_ATTRIBUTE` Engine attribute.
`static String`	`ENGINE_ELEMENT` Engine element.
`static String`	`ENGINES_ELEMENT` Engines element.
`static String`	`GET_METADATA_ROOT` Root element.
`static String`	`GROUP_ELEMENT` Group element.
`static String`	`GROUPS_ELEMENT` Groups element.
`static String`	`INPUTS_ELEMENT` Inputs element.
`static String`	`ORIGIN_ATTRIBUTE` Origin attribute.
`static String`	`ORIGIN_ELEMENT` Origin element.
`static String`	`ORIGINS_ELEMENT` Origins element.
`static String`	`POINTS_ELEMENT` Points element.
`static String`	`PROPERTIES_ELEMENT` Properties element.
`static String`	`REPLICATES_ELEMENT` Replicates element.
`static String`	`RESULTS_ELEMENT` Results element.
`static String`	`STORE_ATTRIBUTE` Store attribute.
`static String`	`STORE_ELEMENT` Store element.
`static String`	`STORES_ELEMENT` Stores element.
`static String`	`SYNCS_ELEMENT` Syncs element.
`static String`	`TEXTS_ELEMENT` Texts element.
`static String`	`TRANSFORMS_ELEMENT` Transforms element.

Constructor Summary

Constructors
Constructor and Description

MetadataFilter(boolean keepEntities)
Constructs an instance.

Constructors
Constructor and Description
`MetadataFilter(boolean keepEntities)` Constructs an instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areAttributesNeeded()` Asks if the attributes are needed.
`boolean`	`areAttributesNeeded(String usage)` Asks if the attributes are needed.
`boolean`	`areBehaviorsNeeded()` Asks if the behaviors are needed.
`boolean`	`areContentsNeeded()` Asks if the contents are needed.
`boolean`	`areContentsRequired()` Asks if the contents are required.
`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`	`areGroupsNeeded()` Asks if the groups are needed.
`boolean`	`areOriginsFiltered()` Asks if the origins are filtered.
`boolean`	`areOriginsNeeded()` Asks if the origins are needed.
`boolean`	`areOriginsRequired()` Asks if the origins are required.
`boolean`	`arePermissionsNeeded()` Asks if the permissions are needed.
`boolean`	`arePointInputsFlagged()` Asks if the point's inputs should be flagged as having results.
`boolean`	`arePointInputsNeeded()` Asks if any point's inputs are needed.
`boolean`	`arePointInputsNeeded(PointEntity pointEntity)` Asks if a point's inputs are needed.
`boolean`	`arePointReplicatesNeeded()` Asks if point's replicates are needed.
`boolean`	`arePointsNeeded()` Asks if any point is needed.
`boolean`	`areStoresFiltered()` Asks if the stores are filtered.
`boolean`	`areStoresNeeded()` Asks if the stores are needed.
`boolean`	`areStoresRequired()` Asks if the stores are required.
`boolean`	`areSyncsNeeded()` Asks if the syncs are needed.
`boolean`	`areTextsNeeded()` Asks if the texts are needed.
`boolean`	`areTransformsNeeded()` Asks if the transforms are needed.
`boolean`	`areTransformsRequired()` Asks if the transforms are required.
`protected MetadataFilter`	`callBack()` Returns a child or this to call back.
`MetadataFilter`	`clone()`
`Optional<String>`	`getClientIdent()` Gets a client identification.
`String`	`getXML(Optional<String> domain, Optional<DateTime> after)` Gets a XML String to send to a metadata server.
`protected void`	`includeAttributesXML(XMLElement root)` Includes attributes request XML if needed.
`protected void`	`includeContentsXML(XMLElement root)` Includes contents request XML if needed.
`protected void`	`includeEnginesXML(XMLElement root)` Includes engines request XML if needed.
`protected void`	`includeGroupsXML(XMLElement root)` Includes groups request XML if needed.
`protected void`	`includeInputsXML(XMLElement root)` Includes inputs request XML if needed.
`protected void`	`includeOriginsXML(XMLElement root)` Includes origins request XML if needed.
`protected void`	`includePointsXML(XMLElement root)` Includes points request XML if needed.
`protected void`	`includeReplicatesXML(XMLElement root)` Includes replicates request XML if needed.
`protected void`	`includeResultsXML(XMLElement root)` Includes results request XML if needed.
`protected void`	`includeStoresXML(XMLElement root)` Includes stores request XML if needed.
`protected void`	`includeSyncsXML(XMLElement root)` Includes syncs request XML if needed.
`protected void`	`includeTextsXML(XMLElement root)` Includes texts request XML if needed.
`protected void`	`includeTransformsXML(XMLElement root)` Includes transforms request XML if needed.
`boolean`	`isEngineNeeded(EngineEntity engineEntity)` Asks if an engine is needed.
`boolean`	`isOriginNeeded(OriginEntity originEntity)` Asks if an origin is needed.
`boolean`	`isPointNeeded(PointEntity pointEntity)` Asks if a point is needed.
`boolean`	`isPointTransformNeeded(PointEntity pointEntity)` Asks if a point's transform is needed.
`boolean`	`isStoreNeeded(StoreEntity storeEntity)` Asks if a store is needed.
`protected void`	`reset()` Resets to pristine state.
`boolean`	`tidy(Metadata metadata)` Tidies the metadata.
`String`	`toString()`

Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AFTER_ATTRIBUTE
```
public static final String AFTER_ATTRIBUTE
```
    After attribute.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTES_ELEMENT
```
public static final String ATTRIBUTES_ELEMENT
```
    Attributes element.
    
    See Also:
    
    Constant Field Values
  - CONTENTS_ELEMENT
```
public static final String CONTENTS_ELEMENT
```
    Contents element.
    
    See Also:
    
    Constant Field Values
  - DOMAIN_ATTRIBUTE
```
public static final String DOMAIN_ATTRIBUTE
```
    Domain attribute.
    
    See Also:
    
    Constant Field Values
  - ENGINES_ELEMENT
```
public static final String ENGINES_ELEMENT
```
    Engines element.
    
    See Also:
    
    Constant Field Values
  - ENGINE_ATTRIBUTE
```
public static final String ENGINE_ATTRIBUTE
```
    Engine attribute.
    
    See Also:
    
    Constant Field Values
  - ENGINE_ELEMENT
```
public static final String ENGINE_ELEMENT
```
    Engine element.
    
    See Also:
    
    Constant Field Values
  - GET_METADATA_ROOT
```
public static final String GET_METADATA_ROOT
```
    Root element.
    
    See Also:
    
    Constant Field Values
  - GROUPS_ELEMENT
```
public static final String GROUPS_ELEMENT
```
    Groups element.
    
    See Also:
    
    Constant Field Values
  - GROUP_ELEMENT
```
public static final String GROUP_ELEMENT
```
    Group element.
    
    See Also:
    
    Constant Field Values
  - INPUTS_ELEMENT
```
public static final String INPUTS_ELEMENT
```
    Inputs element.
    
    See Also:
    
    Constant Field Values
  - ORIGINS_ELEMENT
```
public static final String ORIGINS_ELEMENT
```
    Origins element.
    
    See Also:
    
    Constant Field Values
  - ORIGIN_ATTRIBUTE
```
public static final String ORIGIN_ATTRIBUTE
```
    Origin attribute.
    
    See Also:
    
    Constant Field Values
  - ORIGIN_ELEMENT
```
public static final String ORIGIN_ELEMENT
```
    Origin element.
    
    See Also:
    
    Constant Field Values
  - POINTS_ELEMENT
```
public static final String POINTS_ELEMENT
```
    Points element.
    
    See Also:
    
    Constant Field Values
  - PROPERTIES_ELEMENT
```
public static final String PROPERTIES_ELEMENT
```
    Properties element.
    
    See Also:
    
    Constant Field Values
  - REPLICATES_ELEMENT
```
public static final String REPLICATES_ELEMENT
```
    Replicates element.
    
    See Also:
    
    Constant Field Values
  - RESULTS_ELEMENT
```
public static final String RESULTS_ELEMENT
```
    Results element.
    
    See Also:
    
    Constant Field Values
  - STORES_ELEMENT
```
public static final String STORES_ELEMENT
```
    Stores element.
    
    See Also:
    
    Constant Field Values
  - STORE_ATTRIBUTE
```
public static final String STORE_ATTRIBUTE
```
    Store attribute.
    
    See Also:
    
    Constant Field Values
  - STORE_ELEMENT
```
public static final String STORE_ELEMENT
```
    Store element.
    
    See Also:
    
    Constant Field Values
  - SYNCS_ELEMENT
```
public static final String SYNCS_ELEMENT
```
    Syncs element.
    
    See Also:
    
    Constant Field Values
  - TEXTS_ELEMENT
```
public static final String TEXTS_ELEMENT
```
    Texts element.
    
    See Also:
    
    Constant Field Values
  - TRANSFORMS_ELEMENT
```
public static final String TRANSFORMS_ELEMENT
```
    Transforms element.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MetadataFilter
```
public MetadataFilter(boolean keepEntities)
```
    Constructs an instance.
    
    Parameters:
    
    keepEntities - True to keep entities.
- Method Detail
  - areAttributesNeeded
```
@CheckReturnValue
public boolean areAttributesNeeded()
```
    Asks if the attributes are needed.
    
    Returns:
    
    True if the attributes are needed.
  - areAttributesNeeded
```
@CheckReturnValue
public boolean areAttributesNeeded(@Nonnull
                                                      String usage)
```
    Asks if the attributes are needed.
    
    Parameters:
    
    usage - The usage.
    
    Returns:
    
    True if the attributes are needed.
  - areBehaviorsNeeded
```
@CheckReturnValue
public boolean areBehaviorsNeeded()
```
    Asks if the behaviors are needed.
    
    Returns:
    
    True if the behaviors are needed.
  - areContentsNeeded
```
@CheckReturnValue
public boolean areContentsNeeded()
```
    Asks if the contents are needed.
    
    Returns:
    
    True if the contents are needed.
  - areContentsRequired
```
@CheckReturnValue
public boolean areContentsRequired()
```
    Asks if the contents are required.
    
    Returns:
    
    True if the contents are required.
  - areEnginesFiltered
```
@CheckReturnValue
public boolean areEnginesFiltered()
```
    Asks if the engines are filtered.
    This would be the case if isEngineNeeded(org.rvpf.metadata.entity.EngineEntity) does not always return true.
    
    Returns:
    
    True if the engines are filtered.
  - areEnginesNeeded
```
@CheckReturnValue
public boolean areEnginesNeeded()
```
    Asks if the engines are needed.
    
    Returns:
    
    True if the engines are needed.
  - areEntitiesKept
```
@CheckReturnValue
public boolean areEntitiesKept()
```
    Asks if the entities should be kept.
    
    Returns:
    
    True if the entities should be kept.
  - areGroupsNeeded
```
@CheckReturnValue
public boolean areGroupsNeeded()
```
    Asks if the groups are needed.
    
    Returns:
    
    True if the groups are needed.
  - areOriginsFiltered
```
@CheckReturnValue
public boolean areOriginsFiltered()
```
    Asks if the origins are filtered.
    This would be the case if isOriginNeeded(org.rvpf.metadata.entity.OriginEntity) does not always return true.
    
    Returns:
    
    True if the origins are filtered.
  - areOriginsNeeded
```
@CheckReturnValue
public boolean areOriginsNeeded()
```
    Asks if the origins are needed.
    
    Returns:
    
    True if the origins are needed.
  - areOriginsRequired
```
@CheckReturnValue
public boolean areOriginsRequired()
```
    Asks if the origins are required.
    
    Returns:
    
    True if the origins are required.
  - arePermissionsNeeded
```
@CheckReturnValue
public boolean arePermissionsNeeded()
```
    Asks if the permissions are needed.
    
    Returns:
    
    True if the permissions are needed.
  - arePointInputsFlagged
```
@CheckReturnValue
public boolean arePointInputsFlagged()
```
    Asks if the point's inputs should be flagged as having results.
    
    Returns:
    
    True if point's inputs should be flagged.
  - arePointInputsNeeded
```
@CheckReturnValue
public boolean arePointInputsNeeded()
```
    Asks if any point's inputs are needed.
    
    Returns:
    
    True if any point's inputs are needed.
  - arePointInputsNeeded
```
@CheckReturnValue
public boolean arePointInputsNeeded(@Nonnull
                                                       PointEntity pointEntity)
                                                throws ValidationException
```
    Asks if a point's inputs are needed.
    
    Parameters:
    
    pointEntity - The point Entity.
    
    Returns:
    
    True if the point's inputs are needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - arePointReplicatesNeeded
```
@CheckReturnValue
public boolean arePointReplicatesNeeded()
```
    Asks if point's replicates are needed.
    
    Returns:
    
    True if any point's replicates are needed.
  - arePointsNeeded
```
@CheckReturnValue
public boolean arePointsNeeded()
```
    Asks if any point is needed.
    
    Returns:
    
    True if any point is needed.
  - areStoresFiltered
```
@CheckReturnValue
public boolean areStoresFiltered()
```
    Asks if the stores are filtered.
    This would be the case if isStoreNeeded(org.rvpf.metadata.entity.StoreEntity) does not always return true.
    
    Returns:
    
    True if the stores are filtered.
  - areStoresNeeded
```
@CheckReturnValue
public boolean areStoresNeeded()
```
    Asks if the stores are needed.
    
    Returns:
    
    True if the stores are needed.
  - areStoresRequired
```
@CheckReturnValue
public boolean areStoresRequired()
```
    Asks if the stores are required.
    
    Returns:
    
    True if the stores are required.
  - areSyncsNeeded
```
@CheckReturnValue
public boolean areSyncsNeeded()
```
    Asks if the syncs are needed.
    
    Returns:
    
    True if the syncs are needed.
  - areTextsNeeded
```
@CheckReturnValue
public boolean areTextsNeeded()
```
    Asks if the texts are needed.
    
    Returns:
    
    True if the texts are needed.
  - areTransformsNeeded
```
@CheckReturnValue
public boolean areTransformsNeeded()
```
    Asks if the transforms are needed.
    
    Returns:
    
    True if the transforms are needed.
  - areTransformsRequired
```
@CheckReturnValue
public boolean areTransformsRequired()
```
    Asks if the transforms are required.
    
    Returns:
    
    True if the transforms are required.
  - clone
```
public final MetadataFilter clone()
```
    Overrides:
    
    clone in class Object
  - getClientIdent
```
@Nonnull
 @CheckReturnValue
public Optional<String> getClientIdent()
```
    Gets a client identification.
    
    Returns:
    
    The optional client ident.
  - getXML
```
@Nonnull
 @CheckReturnValue
public String getXML(@Nonnull
                                                   Optional<String> domain,
                                                   @Nonnull
                                                   Optional<DateTime> after)
```
    Gets a XML String to send to a metadata server.
    
    Parameters:
    
    domain - The optional application domain.
    
    after - The optional last update time.
    
    Returns:
    
    The XML String.
  - isEngineNeeded
```
@CheckReturnValue
public boolean isEngineNeeded(@Nonnull
                                                 EngineEntity engineEntity)
                                          throws ValidationException
```
    Asks if an engine is needed.
    
    Parameters:
    
    engineEntity - The engine entity.
    
    Returns:
    
    True if the engine is needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - isOriginNeeded
```
@CheckReturnValue
public boolean isOriginNeeded(@Nonnull
                                                 OriginEntity originEntity)
                                          throws ValidationException
```
    Asks if an origin is needed.
    
    Parameters:
    
    originEntity - The origin entity.
    
    Returns:
    
    True if the origin is needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - isPointNeeded
```
@CheckReturnValue
public boolean isPointNeeded(@Nonnull
                                                PointEntity pointEntity)
                                         throws ValidationException
```
    Asks if a point is needed.
    
    Parameters:
    
    pointEntity - The point entity.
    
    Returns:
    
    True if the point is needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - isPointTransformNeeded
```
@CheckReturnValue
public boolean isPointTransformNeeded(@Nonnull
                                                         PointEntity pointEntity)
                                                  throws ValidationException
```
    Asks if a point's transform is needed.
    
    Parameters:
    
    pointEntity - The point entity.
    
    Returns:
    
    True if the point's transform is needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - isStoreNeeded
```
@CheckReturnValue
public boolean isStoreNeeded(@Nonnull
                                                StoreEntity storeEntity)
                                         throws ValidationException
```
    Asks if a store is needed.
    
    Parameters:
    
    storeEntity - The store entity.
    
    Returns:
    
    True if the store is needed.
    
    Throws:
    
    ValidationException - When appropriate.
  - tidy
```
@CheckReturnValue
public boolean tidy(@Nonnull
                                       Metadata metadata)
```
    Tidies the metadata.
    This is called after the document is loaded.
    
    Parameters:
    
    metadata - The metadata.
    
    Returns:
    
    True on success.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - callBack
```
@CheckReturnValue
protected MetadataFilter callBack()
```
    Returns a child or this to call back.
    
    Returns:
    
    The child or this.
  - includeAttributesXML
```
protected void includeAttributesXML(@Nonnull
                                    XMLElement root)
```
    Includes attributes request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeContentsXML
```
protected void includeContentsXML(@Nonnull
                                  XMLElement root)
```
    Includes contents request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeEnginesXML
```
protected void includeEnginesXML(@Nonnull
                                 XMLElement root)
```
    Includes engines request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeGroupsXML
```
protected void includeGroupsXML(@Nonnull
                                XMLElement root)
```
    Includes groups request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeInputsXML
```
protected void includeInputsXML(@Nonnull
                                XMLElement root)
```
    Includes inputs request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeOriginsXML
```
protected void includeOriginsXML(@Nonnull
                                 XMLElement root)
```
    Includes origins request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includePointsXML
```
protected void includePointsXML(@Nonnull
                                XMLElement root)
```
    Includes points request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeReplicatesXML
```
protected void includeReplicatesXML(@Nonnull
                                    XMLElement root)
```
    Includes replicates request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeResultsXML
```
protected void includeResultsXML(@Nonnull
                                 XMLElement root)
```
    Includes results request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeStoresXML
```
protected void includeStoresXML(@Nonnull
                                XMLElement root)
```
    Includes stores request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeSyncsXML
```
protected void includeSyncsXML(@Nonnull
                               XMLElement root)
```
    Includes syncs request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeTextsXML
```
protected void includeTextsXML(@Nonnull
                               XMLElement root)
```
    Includes texts request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - includeTransformsXML
```
protected void includeTransformsXML(@Nonnull
                                    XMLElement root)
```
    Includes transforms request XML if needed.
    
    Parameters:
    
    root - The root of the XML being built.
  - reset
```
protected void reset()
```
    Resets to pristine state.
    Note: when overriding, call super last to complete reset.

Class MetadataFilter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

AFTER_ATTRIBUTE

ATTRIBUTES_ELEMENT

CONTENTS_ELEMENT

DOMAIN_ATTRIBUTE

ENGINES_ELEMENT

ENGINE_ATTRIBUTE

ENGINE_ELEMENT

GET_METADATA_ROOT

GROUPS_ELEMENT

GROUP_ELEMENT

INPUTS_ELEMENT

ORIGINS_ELEMENT

ORIGIN_ATTRIBUTE

ORIGIN_ELEMENT

POINTS_ELEMENT

PROPERTIES_ELEMENT

REPLICATES_ELEMENT

RESULTS_ELEMENT

STORES_ELEMENT

STORE_ATTRIBUTE

STORE_ELEMENT

SYNCS_ELEMENT

TEXTS_ELEMENT

TRANSFORMS_ELEMENT

Constructor Detail

MetadataFilter

Method Detail

areAttributesNeeded

areAttributesNeeded

areBehaviorsNeeded

areContentsNeeded

areContentsRequired

areEnginesFiltered

areEnginesNeeded

areEntitiesKept

areGroupsNeeded

areOriginsFiltered

areOriginsNeeded

areOriginsRequired

arePermissionsNeeded

arePointInputsFlagged

arePointInputsNeeded

arePointInputsNeeded

arePointReplicatesNeeded

arePointsNeeded

areStoresFiltered

areStoresNeeded

areStoresRequired

areSyncsNeeded

areTextsNeeded

areTransformsNeeded

areTransformsRequired

clone

getClientIdent

getXML

isEngineNeeded

isOriginNeeded

isPointNeeded

isPointTransformNeeded

isStoreNeeded

tidy

toString

callBack

includeAttributesXML

includeContentsXML

includeEnginesXML

includeGroupsXML

includeInputsXML

includeOriginsXML

includePointsXML

includeReplicatesXML

includeResultsXML

includeStoresXML

includeSyncsXML