Package com.cognite.client

Class EngineeringDiagrams

java.lang.Object

com.cognite.client.EngineeringDiagrams

public abstract class EngineeringDiagrams
extends Object

This class represents the Cognite engineering api endpoint It provides methods for detecting entities, annotating and creating interactive diagrams.

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
EngineeringDiagrams()

Method Summary

Modifier and Type	Method	Description
protected Request	addAuthInfo(Request request)	Adds the required authentication information into the request object.
protected Aggregate	aggregate(ResourceType resourceType, Request requestParameters)	Performs an item aggregation request to Cognite Data Fusion.
protected List<String>	buildPartitionsList(int noPartitions)	Builds an array of partition specifications for parallel retrieval from the Cognite api.
List<DiagramResponse>	convert(Collection<DiagramResponse> annotationsList, boolean grayscale)	Convert an engineering diagram (P&ID) in PDF format to an interactive SVG where the provided annotations are highlighted.
protected List<Item>	deDuplicate(Collection<Item> itemList)	De-duplicates a collection of Item.
List<DiagramResponse>	detectAnnotations(Collection<Item> files, Collection<com.google.protobuf.Struct> entities, String searchField, boolean convertToInteractive)	Detect references to assets and files, etc.
List<DiagramResponse>	detectAnnotations(Collection<Item> files, Collection<com.google.protobuf.Struct> entities, String searchField, boolean partialMatch, int minTokens, boolean convertToInteractive)	Detect references to assets and files, etc.
List<DiagramResponse>	detectAnnotations(Collection<Request> requests, boolean convertToInteractive)	Detect references to assets and files, etc.
abstract CogniteClient	getClient()
protected Iterator<CompletableFuture<ResponseItems<String>>>	getListResponseIterator(ResourceType resourceType, Request requestParameters)
protected boolean	itemsHaveId(Collection<Item> items)	Returns true if all items contain either an externalId or id.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String... partitions)	Will return the results from a list / filter api endpoint.
protected Iterator<List<String>>	listJson(ResourceType resourceType, Request requestParameters, String partitionKey, String... partitions)	Will return the results from a list / filter api endpoint.
protected Map<String,Item>	mapItemToId(Collection<Item> items)	Maps all items to their externalId (primary) or id (secondary).
static EngineeringDiagrams	of(CogniteClient client)	Construct a new EngineeringDiagrams object using the provided configuration.
protected List<Item>	parseItems(List<String> input)	Parses a list of item object in json representation to typed objects.
protected String	parseName(String json)	Returns the name attribute value from a json input.
protected String	parseString(String itemJson, String fieldName)	Try parsing the specified Json path as a String.
protected List<String>	retrieveJson(ResourceType resourceType, Collection<Item> items)	Retrieve items by id.
protected List<String>	retrieveJson(ResourceType resourceType, Collection<Item> items, Map<String,Object> parameters)	Retrieve items by id.
protected List<Map<String,Object>>	toRequestItems(Collection<Item> itemList)	Converts a list of Item to a request object structure (that can later be parsed to Json).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

EngineeringDiagrams

public EngineeringDiagrams()

Method Detail

of

public static EngineeringDiagrams of(CogniteClient client)

Construct a new EngineeringDiagrams object using the provided configuration. This method is intended for internal use--SDK clients should always use CogniteClient as the entry point to this class.

Parameters:

client - The CogniteClient to use for configuration settings.

Returns:

The datasets api object.

detectAnnotations

public List<DiagramResponse> detectAnnotations(Collection<Item> files,
                                               Collection<com.google.protobuf.Struct> entities,
                                               String searchField,
                                               boolean convertToInteractive)
                                        throws Exception

Detect references to assets and files, etc. from a P&ID and annotate them with bounding boxes. The P&ID must be a single-page PDF file or an image with JPEG, PNG or TIFF format. The detection will perform complete matches (i.e. partial matches are not accepted).

Parameters:

files - The engineering diagram files to process.

entities - The entities to use for matching.

searchField - The entity attribute to use for string matching.

convertToInteractive - If set to true then an interactive diagram (SVG) will be included in the results.

Returns:

The results from the detect annotations job(s).

Throws:

Exception

detectAnnotations

public List<DiagramResponse> detectAnnotations(Collection<Item> files,
                                               Collection<com.google.protobuf.Struct> entities,
                                               String searchField,
                                               boolean partialMatch,
                                               int minTokens,
                                               boolean convertToInteractive)
                                        throws Exception

Detect references to assets and files, etc. from an engineering diagram and annotate them with bounding boxes. The engineering diagram must be a PDF file or an image with JPEG, PNG or TIFF format.

Parameters:

files - The engineering diagram files to process.

entities - The entities to use for matching.

searchField - The entity attribute to use for string matching.

partialMatch - If set to true, use partial matching

minTokens - The minimum number of tokens (consecutive letters/numbers) required for a match.

convertToInteractive - If set to true then an interactive P&ID (SVG) will be included in the results.

Returns:

The results from the detect annotations job(s).

Throws:

Exception

detectAnnotations

public List<DiagramResponse> detectAnnotations(Collection<Request> requests,
                                               boolean convertToInteractive)
                                        throws Exception

Detect references to assets and files, etc. from an engineering diagram and annotate them with bounding boxes. The engineering diagram must be a PDF file or an image with JPEG, PNG or TIFF format. All input parameters are provided via the request object.

Parameters:

requests - Input parameters for the detect annotations job(s).

convertToInteractive - If set to true then an interactive diagram (SVG) will be included in the results.

Returns:

The results from the detect annotations job(s).

Throws:

Exception

convert

public List<DiagramResponse> convert(Collection<DiagramResponse> annotationsList,
                                     boolean grayscale)
                              throws Exception

Convert an engineering diagram (P&ID) in PDF format to an interactive SVG where the provided annotations are highlighted.

Parameters:

annotationsList - Original engineering diagram with annotations.

grayscale - Set to true to return the SVG/PNG in greyscale (reduces the file size).

Returns:

Annotations together with an interactive SVG/PNG binary

Throws:

Exception

getClient

public abstract CogniteClient getClient()

buildPartitionsList

protected List<String> buildPartitionsList(int noPartitions)

Builds an array of partition specifications for parallel retrieval from the Cognite api. This specification is used as a parameter together with the filter / list endpoints. The number of partitions indicate the number of parallel read streams. Employ one partition specification per read stream.

Parameters:

noPartitions - The total number of partitions

Returns:

a List of partition specifications

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

listJson

protected Iterator<List<String>> listJson(ResourceType resourceType,
                                          Request requestParameters,
                                          String partitionKey,
                                          String... partitions)
                                   throws Exception

Will return the results from a list / filter api endpoint. For example, the filter assets endpoint. The results are paged through / iterated over via an Iterator--the entire results set is not buffered in memory, but streamed in "pages" from the Cognite api. If you need to buffer the entire results set, then you have to stream these results into your own data structure. This method support parallel retrieval via a set of partition specifications. The specified partitions will be collected and merged together before being returned via the Iterator.

Parameters:

resourceType - The resource type to query / filter / list. Ex. event, asset, time series.

requestParameters - The query / filter specification. Follows the Cognite api request parameters.

partitionKey - The key to use for the partitions in the read request. For example partition or cursor.

partitions - An optional set of partitions to read via.

Returns:

an Iterator over the results set.

Throws:

Exception

retrieveJson

protected List<String> retrieveJson(ResourceType resourceType,
                                    Collection<Item> items)
                             throws Exception

Retrieve items by id. Will ignore unknown ids by default.

Parameters:

resourceType - The item resource type (Event, Asset, etc.) to retrieve.

items - The item(s) externalId / id to retrieve.

Returns:

The items in Json representation.

Throws:

Exception

retrieveJson

protected List<String> retrieveJson(ResourceType resourceType,
                                    Collection<Item> items,
                                    Map<String,Object> parameters)
                             throws Exception

Retrieve items by id. This version allows you to explicitly set additional parameters for the retrieve request. For example: <"ignoreUnknownIds", true> and <"fetchResources", true>.

Parameters:

resourceType - The item resource type (Event, Asset, etc.) to retrieve.

items - The item(s) externalId / id to retrieve.

parameters - Additional parameters for the request. For example <"ignoreUnknownIds", true>

Returns:

The items in Json representation.

Throws:

Exception

aggregate

protected Aggregate aggregate(ResourceType resourceType,
                              Request requestParameters)
                       throws Exception

Performs an item aggregation request to Cognite Data Fusion. The default aggregation is a total item count based on the (optional) filters in the request. Some resource types, for example Event, supports multiple types of aggregation.

Parameters:

resourceType - The resource type to perform aggregation of.

requestParameters - The request containing filters.

Returns:

The aggregation result.

Throws:

Exception

See Also:

Cognite API v1 specification

addAuthInfo

protected Request addAuthInfo(Request request)
                       throws Exception

Adds the required authentication information into the request object. If the request object already have complete auth info nothing will be added. The following authentication schemes are supported: 1) API key. When using an api key, this service will look up the corresponding project/tenant to issue requests to.

Parameters:

request - The request to enrich with auth information.

Returns:

The request parameters with auth info added to it.

Throws:

Exception

getListResponseIterator

protected Iterator<CompletableFuture<ResponseItems<String>>> getListResponseIterator(ResourceType resourceType,
                                                                                     Request requestParameters)
                                                                              throws Exception

Throws:

Exception

parseItems

protected List<Item> parseItems(List<String> input)
                         throws Exception

Parses a list of item object in json representation to typed objects.

Parameters:

input - the item list in Json string representation

Returns:

the parsed item objects

Throws:

Exception

toRequestItems

protected List<Map<String,Object>> toRequestItems(Collection<Item> itemList)

Converts a list of Item to a request object structure (that can later be parsed to Json).

Parameters:

itemList - The items to parse.

Returns:

The items in request item object form.

deDuplicate

protected List<Item> deDuplicate(Collection<Item> itemList)

De-duplicates a collection of Item.

Parameters:

itemList -

Returns:

itemsHaveId

protected boolean itemsHaveId(Collection<Item> items)

Returns true if all items contain either an externalId or id.

Parameters:

items -

Returns:

mapItemToId

protected Map<String,Item> mapItemToId(Collection<Item> items)

Maps all items to their externalId (primary) or id (secondary). If the id function does not return any identity, the item will be mapped to the empty string. Via the identity mapping, this function will also perform deduplication of the input items.

Parameters:

items - the items to map to externalId / id.

Returns:

the Map with all items mapped to externalId / id.

parseString

protected String parseString(String itemJson,
                             String fieldName)

Try parsing the specified Json path as a String.

Parameters:

itemJson - The Json string

fieldName - The Json path to parse

Returns:

The Json path as a String.

parseName

protected String parseName(String json)

Returns the name attribute value from a json input.

Parameters:

json - the json to parse

Returns:

The name value