Package nl.bimbase.bimworks.client.apis

Class BimApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.BimApi

public class BimApi
extends SubApi

BIM related API calls, mostly different ways of querying the stored models.

Constructor Summary

Constructors

Constructor	Description
BimApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
UploadModelResponse	applyChangeSet(UUID versionUuid, nl.bimbase.bimworks.common.bimchangeset.BimChangeSet bimChangeSet)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	listBuildingStoreys(Set<UUID> versionUuids)	List all the building storeys of the given models
com.fasterxml.jackson.databind.node.ArrayNode	query(String query, Set<UUID> versionUuids)	Execute a query on the given models
com.fasterxml.jackson.databind.node.ArrayNode	query(String query, UUID... versionUuids)	Execute a query on the given models
com.fasterxml.jackson.databind.node.ArrayNode	query(UUID queryUuid, Set<UUID> versionUuids)
com.fasterxml.jackson.databind.node.ArrayNode	query(BimQuery bimQuery, String[] paths, Set<UUID> versionUuids)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	query(BimQuery bimQuery, String[] paths, UUID... versionUuids)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	query(BimQuery bimQuery, Set<UUID> versionUuids)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	query(BimQuery bimQuery, UUID... versionUuids)	Deprecated.
com.fasterxml.jackson.databind.node.ObjectNode	queryDelegated(BimQuery query, String[] paths, Duration validFor, UUID... versionUuids)	Deprecated.
com.fasterxml.jackson.databind.node.ArrayNode	queryWithToken(com.fasterxml.jackson.databind.node.ObjectNode payload)	Deprecated.
nl.bimbase.bimworks.ResolvedActions	resolveBvl(String input, Set<UUID> versionUuids)	Resolve a BIM.works Visualization Language (BVL), in development
void	setDiscipline(UUID versionUuid, nl.bimbase.bimworks.common.actions.Discipline discipline)	Set the discipline of the given model

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

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

Constructor Details

BimApi

public BimApi(BimWorksClient bimWorksClient)

Method Details

query

public com.fasterxml.jackson.databind.node.ArrayNode query(String query,
 Set<UUID> versionUuids)
                                                    throws BimWorksException,
InterruptedException

Execute a query on the given models

Parameters:

query - The query, serialized using the BQL format

versionUuids - Set of UUID representing the models/Versions to query

Returns:

An ArrayNode with the results. This is untyped because the shape of the results depend on the query

Throws:

BimWorksException

InterruptedException

resolveBvl

public nl.bimbase.bimworks.ResolvedActions resolveBvl(String input,
 Set<UUID> versionUuids)
                                               throws BimWorksException,
InterruptedException

Resolve a BIM.works Visualization Language (BVL), in development

Parameters:

input -

versionUuids -

Returns:

Throws:

BimWorksException

InterruptedException

query

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode query(BimQuery bimQuery,
 String[] paths,
 UUID... versionUuids)
                                                    throws BimWorksException,
InterruptedException

Deprecated.

Throws:

BimWorksException

InterruptedException

query

public com.fasterxml.jackson.databind.node.ArrayNode query(String query,
 UUID... versionUuids)
                                                    throws BimWorksException,
InterruptedException

Execute a query on the given models

Parameters:

query - The query, serialized using the BQL format

versionUuids - One or more UUID representing the models/Versions to query

Returns:

An ArrayNode with the results. This is untyped because the shape of the results depend on the query

Throws:

BimWorksException

InterruptedException

queryDelegated

@Deprecated
public com.fasterxml.jackson.databind.node.ObjectNode queryDelegated(BimQuery query,
 String[] paths,
 Duration validFor,
 UUID... versionUuids)
                                                              throws BimWorksException,
InterruptedException

Deprecated.

Throws:

BimWorksException

InterruptedException

queryWithToken

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode queryWithToken(com.fasterxml.jackson.databind.node.ObjectNode payload)
                                                             throws BimWorksException

Deprecated.

Throws:

BimWorksException

setDiscipline

public void setDiscipline(UUID versionUuid,
 nl.bimbase.bimworks.common.actions.Discipline discipline)
                   throws BimWorksException

Set the discipline of the given model

Parameters:

versionUuid - UUID of the Version

discipline - The discipline

Throws:

BimWorksException

listBuildingStoreys

public com.fasterxml.jackson.databind.node.ArrayNode listBuildingStoreys(Set<UUID> versionUuids)
                                                                  throws InterruptedException,
BimWorksException

List all the building storeys of the given models

Parameters:

versionUuids -

Returns:

Throws:

InterruptedException

BimWorksException

applyChangeSet

@Deprecated
public UploadModelResponse applyChangeSet(UUID versionUuid,
 nl.bimbase.bimworks.common.bimchangeset.BimChangeSet bimChangeSet)
                                   throws BimWorksException

Deprecated.

Parameters:

versionUuid -

bimChangeSet -

Returns:

Throws:

BimWorksException

query

public com.fasterxml.jackson.databind.node.ArrayNode query(UUID queryUuid,
 Set<UUID> versionUuids)
                                                    throws BimWorksException,
InterruptedException

Throws:

BimWorksException

InterruptedException

query

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode query(BimQuery bimQuery,
 String[] paths,
 Set<UUID> versionUuids)
                                                    throws BimWorksException,
InterruptedException

Deprecated.

Throws:

BimWorksException

InterruptedException

query

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode query(BimQuery bimQuery,
 Set<UUID> versionUuids)
                                                    throws BimWorksException,
InterruptedException

Deprecated.

Throws:

BimWorksException

InterruptedException

query

@Deprecated
public com.fasterxml.jackson.databind.node.ArrayNode query(BimQuery bimQuery,
 UUID... versionUuids)
                                                    throws BimWorksException,
InterruptedException

Deprecated.

Throws:

BimWorksException

InterruptedException