org.hawkular.inventory.api.filters

Class With

java.lang.Object

org.hawkular.inventory.api.filters.With

public final class With
extends Object

Since:

0.0.1

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	With.CanonicalPaths
static class	With.DataAt
static class	With.DataOfTypes
static class	With.DataValued
static class	With.Ids
static class	With.PropertyValues
static class	With.RelativePaths
static class	With.Types

Method Summary

Modifier and Type	Method and Description
static With.DataAt	dataAt(RelativePath dataPath) Checks whether there is data on the provided relative path.
static With.DataOfTypes	dataOfTypes(StructuredData.Type... types) Filters for structured data with one of the provided types.
static With.DataValued	dataValue(Serializable value) Filters for structured data with exactly the specified value.
static With.Ids	id(String id)
static With.Ids	ids(String... ids)
static With.CanonicalPaths	path(CanonicalPath path)
static With.CanonicalPaths	paths(CanonicalPath... paths)
static With.PropertyValues	property(String name) Filters for entities that have a property of given name regardless of its value.
static With.PropertyValues	propertyValue(String name, Object value) Filters for entities that have a property of given name equal to given value
static With.PropertyValues	propertyValues(String name, Object... values) Filters for entities that have a property of given name equal to one of the provided values.
static With.RelativePaths	relativePath(String markerLabel, RelativePath path) Constructs a new filter to only contain elements at the current position in the graph traversal that can also be reached using the provided relative path.
static With.RelativePaths	relativePaths(String markerLabel, RelativePath... paths) Constructs a new filter to only contain elements at the current position in the graph traversal that can also be reached using at least one of the provided relative paths.
static With.Types	type(Class<? extends Entity<?,?>> type)
static With.Types	types(Class<? extends Entity<?,?>>... types)

Methods inherited from class java.lang.Object

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

Method Detail

id

public static With.Ids id(String id)

ids

public static With.Ids ids(String... ids)

types

@SafeVarargs
public static With.Types types(Class<? extends Entity<?,?>>... types)

type

public static With.Types type(Class<? extends Entity<?,?>> type)

path

public static With.CanonicalPaths path(CanonicalPath path)

paths

public static With.CanonicalPaths paths(CanonicalPath... paths)

relativePath

public static With.RelativePaths relativePath(String markerLabel,
                                              RelativePath path)

Constructs a new filter to only contain elements at the current position in the graph traversal that can also be reached using the provided relative path.

If the label is null, the relative path is applied directly to the current position in the traversal.

Parameters:

markerLabel - the filter chain this filter is being added to can contain a Marker with this label that marks the position against which the relative path would be resolved against

path - the relative path of the elements.

Returns:

a new filter

relativePaths

public static With.RelativePaths relativePaths(String markerLabel,
                                               RelativePath... paths)

Constructs a new filter to only contain elements at the current position in the graph traversal that can also be reached using at least one of the provided relative paths.

If the label is null, the relative path is applied directly to the current position in the traversal.

Parameters:

markerLabel - the filter chain this filter is being added to can contain a Marker with this label that marks the position against which the relative path would be resolved against

paths - the relative paths of the elements.

Returns:

a new filter

See Also:

relativePath(String, RelativePath)

property

public static With.PropertyValues property(String name)

Filters for entities that have a property of given name regardless of its value.

Parameters:

name - the name of the property

Returns:

the filter

propertyValue

public static With.PropertyValues propertyValue(String name,
                                                Object value)

Filters for entities that have a property of given name equal to given value

Parameters:

name - the name of the property

value - the desired value

Returns:

the filter

propertyValues

public static With.PropertyValues propertyValues(String name,
                                                 Object... values)

Filters for entities that have a property of given name equal to one of the provided values.

Parameters:

name - the name of the property

values - the possible values

Returns:

the filter

dataAt

public static With.DataAt dataAt(RelativePath dataPath)

Checks whether there is data on the provided relative path. This filter is only really applicable on the DataEntity. I.e. the relative path is always resolved against the current position in the traversal, which is assumed to resolve to a data entity.

Parameters:

dataPath - the relative path to the data

Returns:

the filter

dataValue

public static With.DataValued dataValue(Serializable value)

Filters for structured data with exactly the specified value.

Parameters:

value - the value to look for

Returns:

the filter

dataOfTypes

public static With.DataOfTypes dataOfTypes(StructuredData.Type... types)

Filters for structured data with one of the provided types.

Parameters:

types - the types to filter the structured data with

Returns:

the filter

See Also:

StructuredData.getType()