Package step.core.artefacts.reports

Class ReportNodeAccessorImpl

java.lang.Object

step.core.accessors.AbstractAccessor<ReportNode>

step.core.artefacts.reports.ReportNodeAccessorImpl

All Implemented Interfaces:

step.core.accessors.Accessor<ReportNode>, ReportNodeAccessor, ReportTreeAccessor

Direct Known Subclasses:

InMemoryReportNodeAccessor

public class ReportNodeAccessorImpl
extends step.core.accessors.AbstractAccessor<ReportNode>
implements ReportTreeAccessor, ReportNodeAccessor

Field Summary

Fields inherited from class step.core.accessors.AbstractAccessor

collectionDriver, newVersionThresholdMs, versionedCollectionDriver

Constructor Summary

Constructors

Constructor	Description
ReportNodeAccessorImpl(step.core.collections.Collection<ReportNode> collectionDriver)

Method Summary

Modifier and Type	Method	Description
void	createIndexesIfNeeded(Long ttl)
Iterator<ReportNode>	getChildren(String parentID)	Returns the list of children of the ReportNode
Iterator<ReportNode>	getChildren(org.bson.types.ObjectId parentID)
Iterator<ReportNode>	getChildren(org.bson.types.ObjectId parentID, int skip, int limit)
ReportNode	getReportNodeByParentIDAndArtefactID(org.bson.types.ObjectId parentID, org.bson.types.ObjectId artefactID)
List<ReportNode>	getReportNodePath(org.bson.types.ObjectId id)
Stream<ReportNode>	getReportNodesByExecutionID(String executionID)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
Stream<ReportNode>	getReportNodesByExecutionIDAndClass(String executionID, String class_)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
Stream<ReportNode>	getReportNodesByExecutionIDAndCustomAttribute(String executionID, Map<String,String> customAttributes)	Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.
Stream<ReportNode>	getReportNodesWithContributingErrors(String executionID)
ReportNode	getRootReportNode(String executionID)
void	removeNodesByExecutionID(String executionID)

Methods inherited from class step.core.accessors.AbstractAccessor

createOrUpdateCompoundIndex, createOrUpdateIndex, enableVersioning, findByAttributes, findByAttributes, findByCriteria, findManyByAttributes, findManyByAttributes, findManyByCriteria, get, get, getAll, getCollectionDriver, getHistory, getRange, isVersioningEnabled, remove, restoreVersion, save, save, stream, streamLazy

Methods inherited from class java.lang.Object

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

Methods inherited from interface step.core.accessors.Accessor

enableVersioning, findByAttributes, findByAttributes, findByCriteria, findManyByAttributes, findManyByAttributes, findManyByCriteria, get, get, getAll, getCollectionDriver, getHistory, getRange, isVersioningEnabled, remove, restoreVersion, save, save, stream, streamLazy

Methods inherited from interface step.core.artefacts.reports.ReportTreeAccessor

get

Constructor Details

ReportNodeAccessorImpl

public ReportNodeAccessorImpl(step.core.collections.Collection<ReportNode> collectionDriver)

Method Details

createIndexesIfNeeded

public void createIndexesIfNeeded(Long ttl)

Specified by:

createIndexesIfNeeded in interface ReportNodeAccessor

getReportNodePath

public List<ReportNode> getReportNodePath(org.bson.types.ObjectId id)

Specified by:

getReportNodePath in interface ReportNodeAccessor

getChildren

public Iterator<ReportNode> getChildren(org.bson.types.ObjectId parentID)

Specified by:

getChildren in interface ReportNodeAccessor

getChildren

public Iterator<ReportNode> getChildren(org.bson.types.ObjectId parentID,
 int skip,
 int limit)

Specified by:

getChildren in interface ReportNodeAccessor

getReportNodesByExecutionID

public Stream<ReportNode> getReportNodesByExecutionID(String executionID)

Description copied from interface: ReportNodeAccessor

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Specified by:

getReportNodesByExecutionID in interface ReportNodeAccessor

Parameters:

executionID - the id of the execution

Returns:

a Stream with all report nodes of this execution

getReportNodesByExecutionIDAndClass

public Stream<ReportNode> getReportNodesByExecutionIDAndClass(String executionID,
 String class_)

Description copied from interface: ReportNodeAccessor

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Specified by:

getReportNodesByExecutionIDAndClass in interface ReportNodeAccessor

Parameters:

executionID - the id of the execution

class_ - the _class of the report node

Returns:

a Stream with all report nodes of this execution with type class_

getReportNodesByExecutionIDAndCustomAttribute

public Stream<ReportNode> getReportNodesByExecutionIDAndCustomAttribute(String executionID,
 Map<String,String> customAttributes)

Description copied from interface: ReportNodeAccessor

Warning: this method must be used within a try-with-resources statement or similar control structure to ensure that the stream's I/O resources are closed promptly after the stream's operations have completed.

Specified by:

getReportNodesByExecutionIDAndCustomAttribute in interface ReportNodeAccessor

Parameters:

executionID - the id of the execution

customAttributes - filter on customer attributes

Returns:

a Stream with all report nodes of this execution matching provided custom attributes

getReportNodeByParentIDAndArtefactID

public ReportNode getReportNodeByParentIDAndArtefactID(org.bson.types.ObjectId parentID,
 org.bson.types.ObjectId artefactID)

Specified by:

getReportNodeByParentIDAndArtefactID in interface ReportNodeAccessor

getRootReportNode

public ReportNode getRootReportNode(String executionID)

Specified by:

getRootReportNode in interface ReportNodeAccessor

getChildren

public Iterator<ReportNode> getChildren(String parentID)

Description copied from interface: ReportTreeAccessor

Returns the list of children of the ReportNode

Specified by:

getChildren in interface ReportNodeAccessor

Specified by:

getChildren in interface ReportTreeAccessor

Parameters:

parentID - the ID of the parent ReportNode

Returns:

an Iterator of the list of children

getReportNodesWithContributingErrors

public Stream<ReportNode> getReportNodesWithContributingErrors(String executionID)

Specified by:

getReportNodesWithContributingErrors in interface ReportTreeAccessor

removeNodesByExecutionID

public void removeNodesByExecutionID(String executionID)

Specified by:

removeNodesByExecutionID in interface ReportNodeAccessor