DataTypeQueryService

All Known Subinterfaces:: DataTypeManagerService

public interface DataTypeQueryService

Simplified datatype service interface to provide query capabilities to a set of open datatype managers

Method Summary

Modifier and Type

Method

Description

DataType

getDataType(String filterText)

Obtain the preferred datatype which corresponds to the specified datatype specified by filterText.

List<DataType>

getSortedDataTypeList()

Gets the sorted list of all datatypes known by this service via it's owned DataTypeManagers.

Method Details
- getSortedDataTypeList
  
  List<DataType> getSortedDataTypeList()
  
  Gets the sorted list of all datatypes known by this service via it's owned DataTypeManagers. This method can be called frequently, as the underlying data is indexed and only updated as changes are made. The sorting of the list is done using the DataTypeComparator whose primary sort is based upon the DataTypeNameComparator.
  
  Returns:
  
  the sorted list of known data types.
- getDataType
  
  DataType getDataType(String filterText)
  
  Obtain the preferred datatype which corresponds to the specified datatype specified by filterText. A tool-based service provider may prompt the user to select a datatype if more than one possibility exists.
  
  Parameters:
  
  filterText - If not null, this text filters the visible data types to only show those that start with the given text
  
  Returns:
  
  the preferred data type (e.g., chosen by the user) or null if no match found or selection was cancelled by user.