public interface ShapeSearchBuilder extends Builder
ShapeSearch.ShapeSearchBuilder#setSearchType
)
ShapeSearch.ShapeSearchBuilder#setInputAttributesName
ShapeSearch.ShapeSearchBuilder#setInputAttributesFilter
ShapeSearch.ShapeSearchBuilder#inputBody
ShapeSearch.ShapeSearchBuilder#setInputAttributesName
ShapeSearch.ShapeSearchBuilder#setInputAttributesFilter
ShapeSearch.ShapeSearchBuilder#setSearchShapeSimilarity
ShapeSearch.ShapeSearchBuilder#setSearchShapeSize
ShapeSearch.ShapeSearchBuilder#setUseCustomShapeSize
ShapeSearch.ShapeSearchBuilder#setCustomShapeSizeLowerLimit
ShapeSearch.ShapeSearchBuilder#setCustomShapeSizeUpperLimit
ShapeSearch.ShapeSearchBuilder#setInputPart
ShapeSearch.ShapeSearchBuilder#setInputAttributesName
ShapeSearch.ShapeSearchBuilder#setInputAttributesFilter
ShapeSearch.ShapeSearchBuilder#setReferenceSetName
ShapeSearch.ShapeSearchBuilder#setSearchShapeSimilarity
ShapeSearch.ShapeSearchBuilder#setSearchShapeSize
ShapeSearch.ShapeSearchBuilder#setUseCustomShapeSize
ShapeSearch.ShapeSearchBuilder#setCustomShapeSizeLowerLimit
ShapeSearch.ShapeSearchBuilder#setCustomShapeSizeUpperLimit
ShapeSearch.ShapeSearchBuilder#executeSearch
to run the saved search.
After define the search criteria, function ShapeSearch.ShapeSearchBuilder#executeSearch
can search
the shape from database and return the searched results count and error message if fails. The search is specified by 'searchName' parameter.
The method ShapeSearch.ShapeSearchBuilder#getResults
can get the specified results from database. The range of results is specified by the parameters 'startResultId' and 'endResultId', the search is
specified by 'searchName' parameter.
The method ShapeSearch.ShapeSearchBuilder#openResultPart
can open the selected result part of the
specified search. The result is specified by 'resultId' parameter, the search is specified by 'searchName' parameter.
SearchManager.createShapeSearchBuilder(nxopen.Part)
Modifier and Type | Interface and Description |
---|---|
static class |
ShapeSearchBuilder.ExecuteSearchData
This class holds the data returned from
executeSearch(boolean, java.lang.String) |
static class |
ShapeSearchBuilder.OpenPartType
The open part type enum
|
static class |
ShapeSearchBuilder.SearchByType
The search type enum
|
static class |
ShapeSearchBuilder.ShapeSimilarity
The search shape similarity enum
|
static class |
ShapeSearchBuilder.ShapeSize
The search shape size enum
|
Modifier and Type | Method and Description |
---|---|
int |
customShapeSizeLowerLimit()
Returns the custom shape size lower limit to be set for search.
|
int |
customShapeSizeUpperLimit()
Returns the custom shape size upper limit to be set for search.
|
ShapeSearchBuilder.ExecuteSearchData |
executeSearch(boolean isNew,
String searchName)
Execute new search or saved search and output error message if error.
|
String[] |
getInputAttributesFilter()
The input attributes filter to be searched
License requirements: shape_search ("Shape Search") . |
String[] |
getInputAttributesName()
The input attributes name to be searched
License requirements: shape_search ("Shape Search") . |
void |
getResults(String searchName,
int startResultId,
int endResultId)
Get specified search results from database.
|
SelectNXObjectList |
inputBody()
Returns the input body to be searched
License requirements: shape_search ("Shape Search") . |
String |
inputPart()
Returns the input part to be searched
License requirements: shape_search ("Shape Search") . |
void |
openResultPart(ShapeSearchBuilder.OpenPartType openPartType,
String searchName,
int resultId)
Open the searched result part.
|
String |
referenceSetName()
Returns the part reference set name to be set for search
License requirements: shape_search ("Shape Search") . |
ShapeSearchBuilder.ShapeSimilarity |
searchShapeSimilarity()
Returns the shape similarity to be set for search
License requirements: shape_search ("Shape Search") . |
ShapeSearchBuilder.ShapeSize |
searchShapeSize()
Returns the shape size to be set for search.
|
ShapeSearchBuilder.SearchByType |
searchType()
Returns the search type
License requirements: shape_search ("Shape Search") . |
void |
setCustomShapeSizeLowerLimit(int customShapeSizeLowerLimit)
License requirements: shape_search ("Shape Search") . |
void |
setCustomShapeSizeUpperLimit(int customShapeSizeUpperLimit)
License requirements: shape_search ("Shape Search") . |
void |
setInputAttributesFilter(String[] inputAttributesFilter)
The input attributes filter to be searched
License requirements: shape_search ("Shape Search") . |
void |
setInputAttributesName(String[] inputAttributesName)
The input attributes name to be searched
License requirements: shape_search ("Shape Search") . |
void |
setInputPart(String inputPart)
License requirements: shape_search ("Shape Search") . |
void |
setReferenceSetName(String referenceSetName)
License requirements: shape_search ("Shape Search") . |
void |
setSearchShapeSimilarity(ShapeSearchBuilder.ShapeSimilarity searchShapeSimilarity)
License requirements: shape_search ("Shape Search") . |
void |
setSearchShapeSize(ShapeSearchBuilder.ShapeSize searchShapeSize)
License requirements: shape_search ("Shape Search") . |
void |
setSearchType(ShapeSearchBuilder.SearchByType searchType)
License requirements: shape_search ("Shape Search") . |
void |
setUseCustomShapeSize(boolean useCustomShapeSize)
License requirements: shape_search ("Shape Search") . |
boolean |
useCustomShapeSize()
Returns the use custom shape size to control use shape size option or custom shape size
License requirements: shape_search ("Shape Search") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
ShapeSearchBuilder.SearchByType searchType() throws NXException, RemoteException
NXException
RemoteException
void setSearchType(ShapeSearchBuilder.SearchByType searchType) throws NXException, RemoteException
searchType
- NXException
RemoteException
SelectNXObjectList inputBody() throws NXException, RemoteException
NXException
RemoteException
String inputPart() throws NXException, RemoteException
NXException
RemoteException
void setInputPart(String inputPart) throws NXException, RemoteException
inputPart
- NXException
RemoteException
String[] getInputAttributesName() throws NXException, RemoteException
NXException
RemoteException
void setInputAttributesName(String[] inputAttributesName) throws NXException, RemoteException
inputAttributesName
- Search attributes Name NXException
RemoteException
String[] getInputAttributesFilter() throws NXException, RemoteException
NXException
RemoteException
void setInputAttributesFilter(String[] inputAttributesFilter) throws NXException, RemoteException
inputAttributesFilter
- Search attributes filter NXException
RemoteException
String referenceSetName() throws NXException, RemoteException
NXException
RemoteException
void setReferenceSetName(String referenceSetName) throws NXException, RemoteException
referenceSetName
- NXException
RemoteException
ShapeSearchBuilder.ShapeSimilarity searchShapeSimilarity() throws NXException, RemoteException
NXException
RemoteException
void setSearchShapeSimilarity(ShapeSearchBuilder.ShapeSimilarity searchShapeSimilarity) throws NXException, RemoteException
searchShapeSimilarity
- NXException
RemoteException
ShapeSearchBuilder.ShapeSize searchShapeSize() throws NXException, RemoteException
NXException
RemoteException
void setSearchShapeSize(ShapeSearchBuilder.ShapeSize searchShapeSize) throws NXException, RemoteException
searchShapeSize
- NXException
RemoteException
boolean useCustomShapeSize() throws NXException, RemoteException
NXException
RemoteException
void setUseCustomShapeSize(boolean useCustomShapeSize) throws NXException, RemoteException
useCustomShapeSize
- NXException
RemoteException
int customShapeSizeLowerLimit() throws NXException, RemoteException
NXException
RemoteException
void setCustomShapeSizeLowerLimit(int customShapeSizeLowerLimit) throws NXException, RemoteException
customShapeSizeLowerLimit
- NXException
RemoteException
int customShapeSizeUpperLimit() throws NXException, RemoteException
NXException
RemoteException
void setCustomShapeSizeUpperLimit(int customShapeSizeUpperLimit) throws NXException, RemoteException
customShapeSizeUpperLimit
- NXException
RemoteException
ShapeSearchBuilder.ExecuteSearchData executeSearch(boolean isNew, String searchName) throws NXException, RemoteException
isNew
- True is executing new search, False is executing saved searchsearchName
- Search name NXException
RemoteException
void getResults(String searchName, int startResultId, int endResultId) throws NXException, RemoteException
searchName
- Search name startResultId
- Start result idendResultId
- End result idNXException
RemoteException
void openResultPart(ShapeSearchBuilder.OpenPartType openPartType, String searchName, int resultId) throws NXException, RemoteException
openPartType
- Open part typesearchName
- Search name resultId
- Result idNXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.