com.stevewedig.blog.digraph.id_graph

Class IdGraphClass<Id>

java.lang.Object

com.stevewedig.blog.value_objects.ObjectMixin

com.stevewedig.blog.value_objects.ValueMixin

com.stevewedig.blog.digraph.id_graph.IdGraphClass<Id>

All Implemented Interfaces:

IdGraph<Id>, HasObjectHelper

Direct Known Subclasses:

IdDagClass

public class IdGraphClass<Id>
extends ValueMixin
implements IdGraph<Id>

An implementation of IdGraph.

Constructor Summary

Constructors

Constructor and Description
IdGraphClass(com.google.common.collect.ImmutableSet<Id> idSet, com.google.common.collect.ImmutableSetMultimap<Id,Id> id__parentIds)

Method Summary

Methods

Modifier and Type	Method and Description
IdGraph<Id>	ancestorIdGraph(Id id, boolean inclusive) Getting an id's ancestor id graph (its, parents' parents, and so on).
IdGraph<Id>	ancestorIdGraph(Set<Id> ids, boolean inclusive) Getting an id set's ancestor id graph (their parents, parents' parents, and so on).
Iterable<Id>	ancestorIdIterable(Id id, boolean inclusive) Getting an id's ancestor id iterable (its parents, parents' parents, and so on).
Iterable<Id>	ancestorIdIterable(Set<Id> ids, boolean inclusive) Getting an id set's ancestor id iterable (their parents, parents' parents, and so on).
com.google.common.collect.ImmutableSet<Id>	ancestorIdSet(Id id, boolean inclusive) Getting an id's ancestor id set (its parents, parents' parents, and so on).
com.google.common.collect.ImmutableSet<Id>	ancestorIdSet(Set<Id> ids, boolean inclusive) Getting an id set's ancestor id set (their parents, parents' parents, and so on).
void	assertIdsEqual(Id[] ids) Assert that a graph contains exactly these ids.
void	assertIdsEqual(com.google.common.collect.ImmutableSet<Id> ids) Assert that a graph contains exactly these ids.
protected LambdaLib.Fn1<Id,List<Id>>	childIdListLambda()
com.google.common.collect.ImmutableSet<Id>	childIdSet(Id id) Getting an id's child ids.
boolean	containsCycle() Whether the digraph contains a cycle.
IdGraph<Id>	descendantIdGraph(Id id, boolean inclusive) Getting an id's descendant id graph (its children, childrens' children, and so on).
IdGraph<Id>	descendantIdGraph(Set<Id> ids, boolean inclusive) Getting an id set's descendant id graph (their children, childrens' children, and so on).
Iterable<Id>	descendantIdIterable(Id id, boolean inclusive) Getting an id's descendant id iterable (its children, childrens' children, and so on).
Iterable<Id>	descendantIdIterable(Set<Id> ids, boolean inclusive) Getting an id set's descendant id iterable (their children, childrens' children, and so on).
com.google.common.collect.ImmutableSet<Id>	descendantIdSet(Id id, boolean inclusive) Getting an id's descendant id set (its children, childrens' children, and so on).
com.google.common.collect.ImmutableSet<Id>	descendantIdSet(Set<Id> ids, boolean inclusive) Getting an id set's descendant id set (their children, childrens' children, and so on).
Object[]	fields() An array of alternating field names and field values.
IdGraph<Id>	filterIdGraph(Set<Id> ids) Filter a graph by only keep the specified ids and arcs between these ids.
protected com.google.common.collect.SetMultimap<Id,Id>	filterParentMap(Set<Id> ids)
com.google.common.collect.ImmutableSetMultimap<Id,Id>	id__childIds() The mapping from id to child ids.
com.google.common.collect.ImmutableSetMultimap<Id,Id>	id__parentIds() The mapping from id to parent ids.
com.google.common.collect.ImmutableSet<Id>	idSet() The set of ids.
int	idSize() The number of ids.
boolean	isAncestorOf(Id id, Id potentialDescendant, boolean inclusive) Whether an id is a ancestor of another id.
boolean	isChildOf(Id id, Id potentialParent) Whether an id is a child of another id.
boolean	isDescendantOf(Id id, Id potentialAncestor, boolean inclusive) Whether an id is a descendant of another id.
boolean	isLeaf(Id id) Is an id a leaf?
boolean	isParentOf(Id id, Id potentialChild) Whether an id is a parent of another id.
boolean	isRoot(Id id) Is an id a root?
com.google.common.collect.ImmutableSet<Id>	leafIdSet() The digraph's leaf (sink) ids, so the ids without children.
com.google.common.base.Optional<com.google.common.collect.ImmutableList<Id>>	optionalTopsortIdList() A topologically sorted list of ids, with roots (sources) first (will be absent if the digraph is cyclic).
protected LambdaLib.Fn1<Id,List<Id>>	parentIdListLambda()
com.google.common.collect.ImmutableSet<Id>	parentIdSet(Id id) Getting an id's parent ids.
com.google.common.collect.ImmutableSet<Id>	rootIdSet() The digraph's root (source) ids, so the ids without parents.
Iterable<Id>	traverseIdIterable(boolean depthFirst, boolean inclusive, Id startId, LambdaLib.Fn1<Id,List<Id>> expand) Generic id traversal as an iterable.
Iterable<Id>	traverseIdIterable(boolean depthFirst, boolean inclusive, com.google.common.collect.ImmutableList<Id> startIds, LambdaLib.Fn1<Id,List<Id>> expand) Generic id traversal as an iterable.
com.google.common.collect.ImmutableList<Id>	traverseIdList(boolean depthFirst, boolean inclusive, Id startId, LambdaLib.Fn1<Id,List<Id>> expand) Generic id traversal copied into a list.
com.google.common.collect.ImmutableList<Id>	traverseIdList(boolean depthFirst, boolean inclusive, com.google.common.collect.ImmutableList<Id> startIds, LambdaLib.Fn1<Id,List<Id>> expand) Generic id traversal copied into a list.

Methods inherited from class com.stevewedig.blog.value_objects.ValueMixin

equals, hashCode, isEntity

Methods inherited from class com.stevewedig.blog.value_objects.ObjectMixin

array, objectHelper, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IdGraphClass

public IdGraphClass(com.google.common.collect.ImmutableSet<Id> idSet,
            com.google.common.collect.ImmutableSetMultimap<Id,Id> id__parentIds)

Method Detail

fields

public Object[] fields()

Description copied from class: ObjectMixin

An array of alternating field names and field values.

Specified by:

fields in class ObjectMixin

idSet

public com.google.common.collect.ImmutableSet<Id> idSet()

Description copied from interface: IdGraph

The set of ids.

Specified by:

idSet in interface IdGraph<Id>

idSize

public int idSize()

Description copied from interface: IdGraph

The number of ids.

Specified by:

idSize in interface IdGraph<Id>

assertIdsEqual

public void assertIdsEqual(com.google.common.collect.ImmutableSet<Id> ids)

Description copied from interface: IdGraph

Assert that a graph contains exactly these ids.

Specified by:

assertIdsEqual in interface IdGraph<Id>

assertIdsEqual

public void assertIdsEqual(Id[] ids)

Description copied from interface: IdGraph

Assert that a graph contains exactly these ids.

Specified by:

assertIdsEqual in interface IdGraph<Id>

filterIdGraph

public IdGraph<Id> filterIdGraph(Set<Id> ids)

Description copied from interface: IdGraph

Filter a graph by only keep the specified ids and arcs between these ids.

Specified by:

filterIdGraph in interface IdGraph<Id>

isParentOf

public boolean isParentOf(Id id,
                 Id potentialChild)

Description copied from interface: IdGraph

Whether an id is a parent of another id.

Specified by:

isParentOf in interface IdGraph<Id>

id__parentIds

public com.google.common.collect.ImmutableSetMultimap<Id,Id> id__parentIds()

Description copied from interface: IdGraph

The mapping from id to parent ids.

Specified by:

id__parentIds in interface IdGraph<Id>

parentIdSet

public com.google.common.collect.ImmutableSet<Id> parentIdSet(Id id)

Description copied from interface: IdGraph

Getting an id's parent ids.

Specified by:

parentIdSet in interface IdGraph<Id>

parentIdListLambda

protected LambdaLib.Fn1<Id,List<Id>> parentIdListLambda()

filterParentMap

protected com.google.common.collect.SetMultimap<Id,Id> filterParentMap(Set<Id> ids)

isChildOf

public boolean isChildOf(Id id,
                Id potentialParent)

Description copied from interface: IdGraph

Whether an id is a child of another id.

Specified by:

isChildOf in interface IdGraph<Id>

id__childIds

public com.google.common.collect.ImmutableSetMultimap<Id,Id> id__childIds()

Description copied from interface: IdGraph

The mapping from id to child ids.

Specified by:

id__childIds in interface IdGraph<Id>

childIdSet

public com.google.common.collect.ImmutableSet<Id> childIdSet(Id id)

Description copied from interface: IdGraph

Getting an id's child ids.

Specified by:

childIdSet in interface IdGraph<Id>

childIdListLambda

protected LambdaLib.Fn1<Id,List<Id>> childIdListLambda()

isAncestorOf

public boolean isAncestorOf(Id id,
                   Id potentialDescendant,
                   boolean inclusive)

Description copied from interface: IdGraph

Whether an id is a ancestor of another id.

Specified by:

isAncestorOf in interface IdGraph<Id>

ancestorIdIterable

public Iterable<Id> ancestorIdIterable(Id id,
                              boolean inclusive)

Description copied from interface: IdGraph

Getting an id's ancestor id iterable (its parents, parents' parents, and so on).

Specified by:

ancestorIdIterable in interface IdGraph<Id>

ancestorIdIterable

public Iterable<Id> ancestorIdIterable(Set<Id> ids,
                              boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's ancestor id iterable (their parents, parents' parents, and so on).

Specified by:

ancestorIdIterable in interface IdGraph<Id>

ancestorIdSet

public com.google.common.collect.ImmutableSet<Id> ancestorIdSet(Id id,
                                                       boolean inclusive)

Description copied from interface: IdGraph

Getting an id's ancestor id set (its parents, parents' parents, and so on).

Specified by:

ancestorIdSet in interface IdGraph<Id>

ancestorIdSet

public com.google.common.collect.ImmutableSet<Id> ancestorIdSet(Set<Id> ids,
                                                       boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's ancestor id set (their parents, parents' parents, and so on).

Specified by:

ancestorIdSet in interface IdGraph<Id>

ancestorIdGraph

public IdGraph<Id> ancestorIdGraph(Id id,
                          boolean inclusive)

Description copied from interface: IdGraph

Getting an id's ancestor id graph (its, parents' parents, and so on).

Specified by:

ancestorIdGraph in interface IdGraph<Id>

ancestorIdGraph

public IdGraph<Id> ancestorIdGraph(Set<Id> ids,
                          boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's ancestor id graph (their parents, parents' parents, and so on).

Specified by:

ancestorIdGraph in interface IdGraph<Id>

isDescendantOf

public boolean isDescendantOf(Id id,
                     Id potentialAncestor,
                     boolean inclusive)

Description copied from interface: IdGraph

Whether an id is a descendant of another id.

Specified by:

isDescendantOf in interface IdGraph<Id>

descendantIdIterable

public Iterable<Id> descendantIdIterable(Id id,
                                boolean inclusive)

Description copied from interface: IdGraph

Getting an id's descendant id iterable (its children, childrens' children, and so on).

Specified by:

descendantIdIterable in interface IdGraph<Id>

descendantIdIterable

public Iterable<Id> descendantIdIterable(Set<Id> ids,
                                boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's descendant id iterable (their children, childrens' children, and so on).

Specified by:

descendantIdIterable in interface IdGraph<Id>

descendantIdSet

public com.google.common.collect.ImmutableSet<Id> descendantIdSet(Id id,
                                                         boolean inclusive)

Description copied from interface: IdGraph

Getting an id's descendant id set (its children, childrens' children, and so on).

Specified by:

descendantIdSet in interface IdGraph<Id>

descendantIdSet

public com.google.common.collect.ImmutableSet<Id> descendantIdSet(Set<Id> ids,
                                                         boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's descendant id set (their children, childrens' children, and so on).

Specified by:

descendantIdSet in interface IdGraph<Id>

descendantIdGraph

public IdGraph<Id> descendantIdGraph(Id id,
                            boolean inclusive)

Description copied from interface: IdGraph

Getting an id's descendant id graph (its children, childrens' children, and so on).

Specified by:

descendantIdGraph in interface IdGraph<Id>

descendantIdGraph

public IdGraph<Id> descendantIdGraph(Set<Id> ids,
                            boolean inclusive)

Description copied from interface: IdGraph

Getting an id set's descendant id graph (their children, childrens' children, and so on).

Specified by:

descendantIdGraph in interface IdGraph<Id>

isRoot

public boolean isRoot(Id id)

Description copied from interface: IdGraph

Is an id a root?

Specified by:

isRoot in interface IdGraph<Id>

rootIdSet

public com.google.common.collect.ImmutableSet<Id> rootIdSet()

Description copied from interface: IdGraph

The digraph's root (source) ids, so the ids without parents.

Specified by:

rootIdSet in interface IdGraph<Id>

isLeaf

public boolean isLeaf(Id id)

Description copied from interface: IdGraph

Is an id a leaf?

Specified by:

isLeaf in interface IdGraph<Id>

leafIdSet

public com.google.common.collect.ImmutableSet<Id> leafIdSet()

Description copied from interface: IdGraph

The digraph's leaf (sink) ids, so the ids without children.

Specified by:

leafIdSet in interface IdGraph<Id>

optionalTopsortIdList

public com.google.common.base.Optional<com.google.common.collect.ImmutableList<Id>> optionalTopsortIdList()

Description copied from interface: IdGraph

A topologically sorted list of ids, with roots (sources) first (will be absent if the digraph is cyclic).

Specified by:

optionalTopsortIdList in interface IdGraph<Id>

containsCycle

public boolean containsCycle()

Description copied from interface: IdGraph

Whether the digraph contains a cycle.

Specified by:

containsCycle in interface IdGraph<Id>

traverseIdIterable

public Iterable<Id> traverseIdIterable(boolean depthFirst,
                              boolean inclusive,
                              Id startId,
                              LambdaLib.Fn1<Id,List<Id>> expand)

Description copied from interface: IdGraph

Generic id traversal as an iterable.

Specified by:

traverseIdIterable in interface IdGraph<Id>

Parameters:

depthFirst - Whether to traverse depth first or breadth first.

inclusive - Whether to include the start ids in the traversal.

startId - The initial id.

expand - A function mapping an id to the next ids.

Returns:

An id iterable corresponding to the traversal.

traverseIdIterable

public Iterable<Id> traverseIdIterable(boolean depthFirst,
                              boolean inclusive,
                              com.google.common.collect.ImmutableList<Id> startIds,
                              LambdaLib.Fn1<Id,List<Id>> expand)

Description copied from interface: IdGraph

Generic id traversal as an iterable.

Specified by:

traverseIdIterable in interface IdGraph<Id>

Parameters:

depthFirst - Whether to traverse depth first or breadth first.

inclusive - Whether to include the start ids in the traversal.

startIds - The initial id list.

expand - A function mapping an id to the next ids.

Returns:

An id iterable corresponding to the traversal.

traverseIdList

public com.google.common.collect.ImmutableList<Id> traverseIdList(boolean depthFirst,
                                                         boolean inclusive,
                                                         Id startId,
                                                         LambdaLib.Fn1<Id,List<Id>> expand)

Description copied from interface: IdGraph

Generic id traversal copied into a list.

Specified by:

traverseIdList in interface IdGraph<Id>

Parameters:

depthFirst - Whether to traverse depth first or breadth first.

inclusive - Whether to include the start ids in the traversal.

expand - A function mapping an id to the next ids.

Returns:

An id list corresponding to the traversal.

traverseIdList

public com.google.common.collect.ImmutableList<Id> traverseIdList(boolean depthFirst,
                                                         boolean inclusive,
                                                         com.google.common.collect.ImmutableList<Id> startIds,
                                                         LambdaLib.Fn1<Id,List<Id>> expand)

Description copied from interface: IdGraph

Generic id traversal copied into a list.

Specified by:

traverseIdList in interface IdGraph<Id>

Parameters:

depthFirst - Whether to traverse depth first or breadth first.

inclusive - Whether to include the start ids in the traversal.

startIds - The initial id list.

expand - A function mapping an id to the next ids.

Returns:

An id list corresponding to the traversal.