Please enable JavaScript to view this site.

Version:

Navigation: Parameterization for Integration > XML/XSL Processing > VI XSL API > UT specific functions

UT Lookup functions

Prev Top Next More

String lookupUTValue(String version, String utClassId, String searchAttribute, String searchValue, String outputAttribute)

Description

Query a single outputField value from the UT Class classId using the searchField=searchValue condition .

For multiple returned values, only the first hit is returned.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utClassId

UT Class Id from which the value should be queried.

searchAttribute

UT Attribute Component Name from which the query expression is built. This attribute name corresponds to the ATTR_COMPONENT_NAME column in the UT_ATTR_REPOSITORY table.

searchValue

Value of the query expression.

outputAttribute

UT Attribute Component Name for which the result should be returned. This attribute name corresponds to the ATTR_COMPONENT_NAME column in the UT_ATTR_REPOSITORY table.

Return value

The returned value is an output field string. If the query has no results, an empty string is returned.

Example

<xsl:value-of select="utiapi:lookupUTValue('SDE.DEFAULT','3001','E_EQUIPMENT_NR','4711-12','E_EQUIPMENT_NAME')" />

 

NodeList lookupUTValues(String version, String utClassId, String searchAttribute, String searchValue, String outputAttribute)

Description

Query a list of outputField values from the classId UT Class, using the searchField=searchValue condition .

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utClassId

UT Class Id from which the value should be queried.

searchAttribute

UT Attribute Component Name from which the query expression is built. This attribute name corresponds to the ATTR_COMPONENT_NAME column in the UT_ATTR_REPOSITORY table.

searchValue

Value of  the query expression

outputAttribute

UT Attribute Component Name for which the result should be returned. This attribute name corresponds to the ATTR_COMPONENT_NAME column in the UT_ATTR_REPOSITORY table.

Return value

The returned value is an output field NodeList with values. If the query has no results, an empty NodeList is returned.

The NodeList contains Text type nodes.

Example:

1.Get NodeList size:
<xsl:value-of select="count(utiapi:lookupUTValues('SDE.DEFAULT','3001','E_EQUIPMENT_NR','4711','E_EQUIPMENT_NAME'))"/>

2.Get a second value from NodeList:
<xsl:value-of select="utiapi:lookupUTValues('SDE.DEFAULT','3001','E_EQUIPMENT_NR','4711','E_EQUIPMENT_NAME')[2]"/>

3.Iterate over NodeList with xsl:for-each:
<xsl:for-each select="utiapi:lookupUTValues('SDE.DEFAULT','3001','E_EQUIPMENT_NR','4711','E_EQUIPMENT_NAME')">
<result><xsl:value-of select="." /></result>
</xsl:for-each>

 

NodeList lookupDetailObjects(String version, String utObjId, String utClassId, String detailUtClassIds)

Description

Query a list of UT Object Identifiers from the classId UT Class, using the searchField=searchValue condition .

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

utClassId

UT Class Id from which the value should be queried.

detailUtClassIds

Comma-separated list of UT Class Ids detail classes that should be queried.

Return value

The returned value is a NodeList with UT Object Identifier (OBJ_ID), matching the detail objects. If the query has no results, an empty NodeList is returned.

The NodeList contains Text type nodes.

Example:

1.Get NodeList size:
<xsl:value-of select="count(utiapi:lookupDetailObjects('SDE.DEFAULT','0002081114120370007924','3001','2002,2018'))"/>

2.Get a second value from NodeList:
<xsl:value-of select="utiapi:lookupDetailObjects('SDE.DEFAULT','0002081114120370007924','3001','2002,2018')[2]"/>

3.Iterate over NodeList with xsl:for-each:
<xsl:for-each select="utiapi:lookupDetailObjects('SDE.DEFAULT','0002081114120370007924','3001','2002,2018')">
<result><xsl:value-of select="." /></result>
</xsl:for-each>

 

NodeList lookupMasterObjects(String version, String utObjId, String utClassId, String masterUtClassIds)

Description

Query list of UT Object Identifiers from the UT Class classId using the condition searchField=searchValue .

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

utClassId

UT Class Id from which the value should be queried.

masterUtClassIds

Comma-separated list of UT Class Ids of master classes that should be queried.

Return value

The returned value is a NodeList with the UT Object Identifier (OBJ_ID) of the matching master objects. If the query has no results, an empty NodeList is returned.

The NodeList contains nodes of type Text.

Example:

1.Get size of NodeList:
<xsl:value-of select="count(utiapi:lookupDetailObjects('SDE.DEFAULT','0003211756090615553944','2002','3001,3007'))"/>

2.Get second value from NodeList:
<xsl:value-of select="utiapi:lookupDetailObjects('SDE.DEFAULT','0003211756090615553944','2002','3001,3007')[2]"/>

3.Iterate over NodeList with xsl:for-each:
<xsl:for-each select="utiapi:lookupDetailObjects('SDE.DEFAULT','0003211756090615553944','2002','3001,3007')">   <result><xsl:value-of select="." /></result>
</xsl:for-each>

 

String getClassIdFromGisId(String version, String utObjId)

Description

Query the UT Class Id of an UT object. This function works only for the UT objects that are modeled as complex objects.

Parameter

Value

utObjId

UT object identifier (OBJ_ID)

Return value

The returned value is a UT Class Id as a String. If the utObjId could not be found, an empty String is returned.

Example:

<result><xsl:value-of select="utiapi:getClassIdFromGisId('SDE.DEFAULT','0002081114120370007924')" /></result>

 

String getSubClassIdFromGisId(String version, String utObjId)

Description

Query the UT Subtype Id of an UT object. This function works only for the UT objects that are modeled as complex objects.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

Return value

The returned value is an UT Subtype Id as a String. If the utObjId could not be found, an empty String is returned.

Example:

<result><xsl:value-of select="utiapi:getSubClassIdFromGisId('SDE.DEFAULT','0002081114120370007924')" /></result>

 

NodeList getClassIdSubtypeIdFromGisId(String version, String utObjId)

Description

Query the UT Class Id and Subtype Id of an UT object. This function works only for UT objects that are modelled as complex objects.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

Return value

The returned value is a NodeList with UT Class Id (index 1) and Subtype Id (index 2). If the utObjId is not found, an empty NodeList is returned.

The NodeList contains Text type nodes.

Example:

<result><xsl:variable name="UTCLASS" select="utiapi:getClassIdSubtypeIdFromGisId('SDE.DEFAULT','0002081114120370007924')"

<classid><xsl:value-of select ="$UTCLASS[1]" /></classid>

<subtype><xsl:value-of select ="$UTCLASS[2]" /></subtype>

/></result>

 

String getStatusFromGisId(String version, String utObjId)

Description

Query the UT Status of an UT object. This function works only for the UT objects that are modeled as complex objects.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

Return value

The returned value is an UT Status as a String. If the utObjId could is not found, an empty String is returned.

Example:

<result><xsl:value-of select="utiapi:getStatusFromGisId('SDE.DEFAULT','0002081114120370007924')" /></result>

 

String getStatusFromGisId(String version, String utObjId, String utClassId, String utSubtypeId)

Description

Query the UT Status of an UT object.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utObjId

UT object identifier (OBJ_ID).

utClassId

UT Class Id.

utSubtypeId

UT Subtype Id.

Return value

The returned value is an UT Status as a String. If the UT object is not found, an empty String is returned.

Example:

<result><xsl:value-of select="utiapi:getStatusFromGisId('SDE.DEFAULT','0002081114120370007924')" /></result>

 

String lookupUTObjId(String version, String utClassId, String searchField, String searchValue, String excludeUtStatusList)

Description

Query a single UT obejct Id (OBJ_ID) from the class_id=utClassId UT class, using the searchField=searchValue condition. Using the excludeUtStatusList, parameter, certain UT status values ​​can be excluded from the search.

If more than one value is found, an exception is thrown.

Parameter

Value

version

Fully qualified name of the version (e.g. SDE.DEFAULT).

utClassId

UT Class Id from which the value should be queried.

searchField

Field name of the query expression.

searchValue

Value of the query expression.

excludeUtStatusList

Comma-separated List with UT status values that should be excluded from the search

Return value

The returned value is an output field String. If the query has no result an empty string is returned. If more than one UT object Id was found an UTI Exception is thrown.

Example:

<result><xsl:value-of select="utiapi:lookupUTObjId('SDE.DEFAULT','3001','E_EQUIPMENT_NR','4711','7,8,9')" /></result>

 

String lookupAddressId(String communityName, String commpartName, String streetName, String houseNumber)

Description

Query an UT address Id from the A_ADDRESS table for a postal address defined by communityName, commpartName, streetName, houseNumber.

Parameter

Value

communityName

Name of the community (see table A_COMMUNITY, field COMM_NAME).

commpartName

Name of the community part (optional) (see table A_COMMPART, field COMMPART_NAME).

streetName

Name of the street (see table A_STREET, field STREET_NAME).

houseNumber

Housenumber (see table A_ADDRESS, field HOUSE_NO).

Return value

The returned value is an address Id String. If the query has no results, an empty string is returned.

Example:

<result><xsl:value-of select="utiapi:lookupAddressId('Berlin','Mitte','Friedrichstr.','106a')" /></result>

 

String lookupCatalogOperator(String utClassId, String catalogTable, String searchField, String searchValue)

Description

Query a catalog operator value (field OPERATOR) from an UT catalog table.

Parameter

Value

utClassId

UT Class Id from which the cataolg operator should be queried.

catalogTable

Name of the catalog table.

searchField

Field name for the query expression.

searchValue

Value for the query expression.

Return value

The returned value is a catalog operator String. If the query has no results, an empty string is returned.

Example:

<result><xsl:value-of select="utiapi:lookupCatalogOperator('3001','ut_c_catalog','max_burden','0.0')" /></result>

© 2024 VertiGIS GmbH. All Rights Reserved. | Privacy Center | Imprint
Documentation Version 10.0 (fa3b2a93)