StandardLineageResult (nifi-data-provenance-utils 1.17.0 API)

java.lang.Object
- org.apache.nifi.provenance.StandardLineageResult

All Implemented Interfaces:: ComputeLineageResult, ProgressiveResult

public class StandardLineageResult
extends Object
implements ComputeLineageResult, ProgressiveResult

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`canceled`
`private Object`	`completionMonitor`
`private long`	`computationNanos`
`private long`	`creationNanos`
`private Set<LineageEdge>`	`edges`
`private String`	`error`
`private Date`	`expirationDate`
`private Collection<String>`	`flowFileUuids`
`private static org.slf4j.Logger`	`logger`
`private Set<LineageNode>`	`nodes`
`private int`	`numCompletedSteps`
`private int`	`numSteps`
`private Lock`	`readLock`
`private Set<ProvenanceEventRecord>`	`relevantRecords`
`private ReadWriteLock`	`rwLock`
`static int`	`TTL`
`private Lock`	`writeLock`

Constructor Summary

Constructors
Constructor and Description

StandardLineageResult(int numSteps, Collection<String> flowFileUuids)

Constructors
Constructor and Description
`StandardLineageResult(int numSteps, Collection<String> flowFileUuids)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitCompletion(long time, TimeUnit unit)`
`(package private) void`	`cancel()`
`private void`	`computeLineage()` Computes the lineage from the relevant Provenance Event Records.
`long`	`getComputationTime(TimeUnit timeUnit)`
`List<LineageEdge>`	`getEdges()`
`String`	`getError()`
`Date`	`getExpiration()`
`List<LineageNode>`	`getNodes()`
`int`	`getPercentComplete()`
`long`	`getTotalHitCount()`
`boolean`	`isFinished()`
`void`	`setError(String error)`
`void`	`update(Collection<ProvenanceEventRecord> records, long totalHitCount)`
`private void`	`updateExpiration()` Must be called with write lock!

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TTL
```
public static final int TTL
```

logger

private static final org.slf4j.Logger logger

flowFileUuids

private final Collection<String> flowFileUuids

relevantRecords

private final Set<ProvenanceEventRecord> relevantRecords

nodes
```
private final Set<LineageNode> nodes
```

edges
```
private final Set<LineageEdge> edges
```

numSteps
```
private final int numSteps
```

creationNanos
```
private final long creationNanos
```

computationNanos
```
private long computationNanos
```

rwLock
```
private final ReadWriteLock rwLock
```

readLock
```
private final Lock readLock
```

writeLock
```
private final Lock writeLock
```

expirationDate
```
private Date expirationDate
```

error
```
private String error
```

numCompletedSteps
```
private int numCompletedSteps
```

canceled
```
private volatile boolean canceled
```

completionMonitor
```
private final Object completionMonitor
```

Constructor Detail

StandardLineageResult

public StandardLineageResult(int numSteps,
                             Collection<String> flowFileUuids)

Method Detail
- getNodes
```
public List<LineageNode> getNodes()
```
  Specified by:
  
  getNodes in interface ComputeLineageResult
- getEdges
```
public List<LineageEdge> getEdges()
```
  Specified by:
  
  getEdges in interface ComputeLineageResult
- getComputationTime
```
public long getComputationTime(TimeUnit timeUnit)
```
- getExpiration
```
public Date getExpiration()
```
  Specified by:
  
  getExpiration in interface ComputeLineageResult
- getError
```
public String getError()
```
  Specified by:
  
  getError in interface ComputeLineageResult
- getPercentComplete
```
public int getPercentComplete()
```
  Specified by:
  
  getPercentComplete in interface ComputeLineageResult
- isFinished
```
public boolean isFinished()
```
  Specified by:
  
  isFinished in interface ComputeLineageResult
  
  Specified by:
  
  isFinished in interface ProgressiveResult
- setError
```
public void setError(String error)
```
  Specified by:
  
  setError in interface ProgressiveResult
- update
```
public void update(Collection<ProvenanceEventRecord> records,
                   long totalHitCount)
```
  Specified by:
  
  update in interface ProgressiveResult
- computeLineage
```
private void computeLineage()
```
  Computes the lineage from the relevant Provenance Event Records. This method must be called with the write lock held and is only going to be useful after all of the records have been successfully obtained
- cancel
```
void cancel()
```
- updateExpiration
```
private void updateExpiration()
```
  Must be called with write lock!
- awaitCompletion
```
public boolean awaitCompletion(long time,
                               TimeUnit unit)
                        throws InterruptedException
```
  Specified by:
  
  awaitCompletion in interface ComputeLineageResult
  
  Throws:
  
  InterruptedException
- getTotalHitCount
```
public long getTotalHitCount()
```
  Specified by:
  
  getTotalHitCount in interface ProgressiveResult

Class StandardLineageResult

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TTL

logger

flowFileUuids

relevantRecords

nodes

edges

numSteps

creationNanos

computationNanos

rwLock

readLock

writeLock

expirationDate

error

numCompletedSteps

canceled

completionMonitor

Constructor Detail

StandardLineageResult

Method Detail

getNodes

getEdges

getComputationTime

getExpiration

getError

getPercentComplete

isFinished

setError

update

computeLineage

cancel

updateExpiration

awaitCompletion

getTotalHitCount