com.mware.ge

Class FetchHints

java.lang.Object

com.mware.ge.FetchHints

All Implemented Interfaces:

Serializable

public class FetchHints
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FetchHints	ALL
static FetchHints	ALL_INCLUDING_HIDDEN
static FetchHints	EDGE_LABELS
static FetchHints	EDGE_REFS
static FetchHints	NONE
static FetchHints	PROPERTIES
static FetchHints	PROPERTIES_AND_EDGE_REFS
static FetchHints	PROPERTIES_AND_METADATA

Method Summary

Modifier and Type	Method and Description
void	assertMetadataIncluded(String key)
void	assertPropertyIncluded(String name)
static FetchHintsBuilder	builder()
static FetchHintsBuilder	builder(FetchHints fetchHints)
static FetchHints	copyAndMakeVisible(FetchHints fetchHints)
boolean	equals(Object o)
com.google.common.collect.ImmutableSet<String>	getEdgeLabelsOfEdgeRefsToInclude()
com.google.common.collect.ImmutableSet<String>	getMetadataKeysToInclude()
com.google.common.collect.ImmutableSet<String>	getPropertyNamesToInclude()
boolean	hasEdgeLabelsOfEdgeRefsToInclude()
boolean	hasFetchHints(FetchHints fetchHints) Tests that these fetch hints have at least the requested fetch hints
int	hashCode()
boolean	isIncludeAllEdgeRefs()
boolean	isIncludeAllProperties()
boolean	isIncludeAllPropertyMetadata()
boolean	isIncludeEdgeIds()
boolean	isIncludeEdgeLabelsAndCounts()
boolean	isIncludeEdgeRefLabel(String label)
boolean	isIncludeEdgeRefs()
boolean	isIncludeEdgeVertexIds()
boolean	isIncludeExtendedDataTableNames()
boolean	isIncludeHidden()
boolean	isIncludeInEdgeRefs()
boolean	isIncludeMetadata(String metadataKey)
boolean	isIncludeOutEdgeRefs()
boolean	isIncludeProperties()
boolean	isIncludeProperty(String propertyName)
boolean	isIncludePropertyAndMetadata(String propertyName)
boolean	isIncludePropertyMetadata()
String	toString()
static FetchHints	union(FetchHints... fetchHints)
static FetchHints	union(Iterable<FetchHints> fetchHints)
void	validateHasEdgeFetchHints(Direction direction, String... labels)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final FetchHints NONE

PROPERTIES

public static final FetchHints PROPERTIES

PROPERTIES_AND_EDGE_REFS

public static final FetchHints PROPERTIES_AND_EDGE_REFS

PROPERTIES_AND_METADATA

public static final FetchHints PROPERTIES_AND_METADATA

ALL

public static final FetchHints ALL

ALL_INCLUDING_HIDDEN

public static final FetchHints ALL_INCLUDING_HIDDEN

EDGE_REFS

public static final FetchHints EDGE_REFS

EDGE_LABELS

public static final FetchHints EDGE_LABELS

Method Detail

copyAndMakeVisible

public static FetchHints copyAndMakeVisible(FetchHints fetchHints)

isIncludeAllProperties

public boolean isIncludeAllProperties()

getPropertyNamesToInclude

public com.google.common.collect.ImmutableSet<String> getPropertyNamesToInclude()

isIncludeAllPropertyMetadata

public boolean isIncludeAllPropertyMetadata()

getMetadataKeysToInclude

public com.google.common.collect.ImmutableSet<String> getMetadataKeysToInclude()

isIncludeHidden

public boolean isIncludeHidden()

isIncludeAllEdgeRefs

public boolean isIncludeAllEdgeRefs()

isIncludeOutEdgeRefs

public boolean isIncludeOutEdgeRefs()

isIncludeInEdgeRefs

public boolean isIncludeInEdgeRefs()

isIncludeEdgeIds

public boolean isIncludeEdgeIds()

isIncludeEdgeVertexIds

public boolean isIncludeEdgeVertexIds()

getEdgeLabelsOfEdgeRefsToInclude

public com.google.common.collect.ImmutableSet<String> getEdgeLabelsOfEdgeRefsToInclude()

isIncludeEdgeLabelsAndCounts

public boolean isIncludeEdgeLabelsAndCounts()

isIncludeExtendedDataTableNames

public boolean isIncludeExtendedDataTableNames()

isIncludePropertyMetadata

public boolean isIncludePropertyMetadata()

isIncludeProperties

public boolean isIncludeProperties()

isIncludePropertyAndMetadata

public boolean isIncludePropertyAndMetadata(String propertyName)

isIncludeProperty

public boolean isIncludeProperty(String propertyName)

isIncludeMetadata

public boolean isIncludeMetadata(String metadataKey)

isIncludeEdgeRefLabel

public boolean isIncludeEdgeRefLabel(String label)

isIncludeEdgeRefs

public boolean isIncludeEdgeRefs()

hasEdgeLabelsOfEdgeRefsToInclude

public boolean hasEdgeLabelsOfEdgeRefsToInclude()

validateHasEdgeFetchHints

public void validateHasEdgeFetchHints(Direction direction,
                                      String... labels)

toString

public String toString()

Overrides:

toString in class Object

builder

public static FetchHintsBuilder builder()

builder

public static FetchHintsBuilder builder(FetchHints fetchHints)

assertPropertyIncluded

public void assertPropertyIncluded(String name)

assertMetadataIncluded

public void assertMetadataIncluded(String key)

hasFetchHints

public boolean hasFetchHints(FetchHints fetchHints)

Tests that these fetch hints have at least the requested fetch hints

Returns:

true if this has all or more fetch hints then those passed in.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

union

public static FetchHints union(FetchHints... fetchHints)

union

public static FetchHints union(Iterable<FetchHints> fetchHints)