public interface SubsetRecipe extends TaggedObjectCollection
SubsetBuilder
to collect SearchTerm
s.
The search terms specify the search that defines the contents of a Subset
.
SubsetBuilder
TaggedObjectCollection.Iterator
Modifier and Type | Method and Description |
---|---|
void |
addSearchTermBuilder(SearchTermBuilder searchTermBuilder)
Add a
SearchTermBuilder to the recipe. |
AttributeSearchTerm |
createAttributeSearchTerm(SearchTerm.SearchTermLogicType logicType,
String queryName,
String[] entries,
String[] values)
Creates a
AttributeSearchTerm and
adds it to the recipe at the end of the list of search terms. |
BoxSearchTerm |
createBoxSearchTerm(SearchTerm.SearchTermLogicType logicType,
BoxSearchTerm.BoxOverlapLogicType overlapType,
Point3d bottomCorner,
Point3d topCorner,
boolean trueShapeRefinement)
Creates a
BoxSearchTerm and
adds it to the recipe at the end of the list of search terms. |
ExplicitSearchTerm |
createExplicitSearchTerm(SearchTerm.SearchTermLogicType logicType,
SearchResultElement searchResultElement)
Creates a
ExplicitSearchTerm and
adds it to the recipe at the end of the list of search terms. |
GroupSearchTerm |
createExplicitSearchTermGroup(SearchTerm.SearchTermLogicType logicType,
SearchResultElement[] searchResultElements)
Creates a
GroupSearchTerm of ExplicitSearchTerm s and
adds it to the recipe at the end of the list of search terms. |
PartitionSearchTerm |
createPartitionSearchTerm(SearchTerm.SearchTermLogicType logicType,
Partition partition)
Creates a
PartitionSearchTerm and
adds it to the recipe at the end of the list of search terms. |
GroupSearchTerm |
createPartitionSearchTermGroup(SearchTerm.SearchTermLogicType logicType,
Partition[] partitions)
Creates a
GroupSearchTerm of PartitionSearchTerm s and
adds it to the recipe at the end of the list of search terms. |
PlaneSearchTerm |
createPlaneSearchTerm(SearchTerm.SearchTermLogicType logicType,
PlaneSearchTerm.PlaneOverlapLogicType overlapType,
Vector3d normal,
double displacement,
Point3d pointOnPlane,
boolean trueShapeRefinement)
Creates a
PlaneSearchTerm and
adds it to the recipe at the end of the list of search terms. |
ProximitySearchTerm |
createProximitySearchTerm(SearchTerm.SearchTermLogicType logicType,
SearchResultElement[] seeds,
double distance,
boolean trueShapeRefinement)
Creates a
ProximitySearchTerm and
adds it to the recipe at the end of the list of search terms. |
void |
deleteSearchTerms(SearchTerm[] searchTerms)
Removes the
SearchTerm s from the recipe and deletes them. |
SearchTerm |
findObject(String journalIdentifier)
Finds the
SearchTerm with the given identifier as recorded in a journal. |
String[] |
getAllSearchOptions(String optionSet)
Gets the internal names of all search options from specified option set as defined in database.
|
String[] |
getAllSearchOptionSets()
Gets the internal names of all option sets defined in database.
|
boolean |
getSearchOptionValue(String optionSet,
String searchOption)
Gets value of specified search option from given option set.
|
void |
group(SearchTerm.SearchTermLogicType logicType,
SearchTerm[] searchTerms)
Put the
SearchTerm s in a new GroupSearchTerm . |
void |
moveDown(SearchTerm searchTerm)
Move a
SearchTerm down to another location in the recipe. |
void |
moveUp(SearchTerm searchTerm)
Move a
SearchTerm up to another location in the recipe. |
void |
setSearchOptionValue(String optionSet,
String searchOption,
boolean optionValue)
Sets value of specified search option from given option set.
|
void |
setSearchTermLogic(SearchTerm.SearchTermLogicType logicType,
SearchTerm[] searchTerms)
Changes the search term logic of each
SearchTerm s passed in. |
void |
ungroup(SearchTerm[] searchTerms)
Any
GroupSearchTerm s in the input search terms will be removed
from the recipe. |
_find_next, iterator
SearchTerm findObject(String journalIdentifier) throws NXException, RemoteException
SearchTerm
with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of
the software. However newer versions of the software should find the same object when
FindObject is passed older versions of its journal identifier. In general, this method
should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
journalIdentifier
- Name of the search term to be foundNXException
RemoteException
ExplicitSearchTerm createExplicitSearchTerm(SearchTerm.SearchTermLogicType logicType, SearchResultElement searchResultElement) throws NXException, RemoteException
ExplicitSearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- searchResultElement
- NXException
RemoteException
GroupSearchTerm createExplicitSearchTermGroup(SearchTerm.SearchTermLogicType logicType, SearchResultElement[] searchResultElements) throws NXException, RemoteException
GroupSearchTerm
of ExplicitSearchTerm
s and
adds it to the recipe at the end of the list of search terms.
logicType
- searchResultElements
- NXException
RemoteException
void addSearchTermBuilder(SearchTermBuilder searchTermBuilder) throws NXException, RemoteException
SearchTermBuilder
to the recipe. When this search term builder
is committed the search term will be added to the recipe at the end of the list of search terms.
searchTermBuilder
- NXException
RemoteException
BoxSearchTerm createBoxSearchTerm(SearchTerm.SearchTermLogicType logicType, BoxSearchTerm.BoxOverlapLogicType overlapType, Point3d bottomCorner, Point3d topCorner, boolean trueShapeRefinement) throws NXException, RemoteException
BoxSearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- overlapType
- bottomCorner
- Vertex of zone in workset part coordinatestopCorner
- Opposite vertex of zone in workset part coordinatestrueShapeRefinement
- Apply TrueShape refinement to volume searchNXException
RemoteException
ProximitySearchTerm createProximitySearchTerm(SearchTerm.SearchTermLogicType logicType, SearchResultElement[] seeds, double distance, boolean trueShapeRefinement) throws NXException, RemoteException
ProximitySearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- seeds
- distance
- Distance in workset part unitstrueShapeRefinement
- Apply TrueShape refinement to proximity searchNXException
RemoteException
PlaneSearchTerm createPlaneSearchTerm(SearchTerm.SearchTermLogicType logicType, PlaneSearchTerm.PlaneOverlapLogicType overlapType, Vector3d normal, double displacement, Point3d pointOnPlane, boolean trueShapeRefinement) throws NXException, RemoteException
PlaneSearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- overlapType
- normal
- Unitized plane normaldisplacement
- Displacement in workset part unitspointOnPlane
- Point On Plane in workset part coordinatestrueShapeRefinement
- Apply TrueShape refinement to plane searchNXException
RemoteException
AttributeSearchTerm createAttributeSearchTerm(SearchTerm.SearchTermLogicType logicType, String queryName, String[] entries, String[] values) throws NXException, RemoteException
AttributeSearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- queryName
- Name of the saved query upon which this search term is basedentries
- search criteria entriesvalues
- search criteria valuesNXException
RemoteException
PartitionSearchTerm createPartitionSearchTerm(SearchTerm.SearchTermLogicType logicType, Partition partition) throws NXException, RemoteException
PartitionSearchTerm
and
adds it to the recipe at the end of the list of search terms.
logicType
- partition
- The partition upon which this search term is basedNXException
RemoteException
GroupSearchTerm createPartitionSearchTermGroup(SearchTerm.SearchTermLogicType logicType, Partition[] partitions) throws NXException, RemoteException
GroupSearchTerm
of PartitionSearchTerm
s and
adds it to the recipe at the end of the list of search terms.
logicType
- partitions
- NXException
RemoteException
void moveUp(SearchTerm searchTerm) throws NXException, RemoteException
SearchTerm
up to another location in the recipe.
searchTerm
- NXException
RemoteException
void moveDown(SearchTerm searchTerm) throws NXException, RemoteException
SearchTerm
down to another location in the recipe.
searchTerm
- NXException
RemoteException
void group(SearchTerm.SearchTermLogicType logicType, SearchTerm[] searchTerms) throws NXException, RemoteException
SearchTerm
s in a new GroupSearchTerm
.
The group is placed in the recipe at the location of the first search term.
logicType
- searchTerms
- NXException
RemoteException
void ungroup(SearchTerm[] searchTerms) throws NXException, RemoteException
GroupSearchTerm
s in the input search terms will be removed
from the recipe. The members of the group will be re-parented as members of the
group's parent.
searchTerms
- NXException
RemoteException
void deleteSearchTerms(SearchTerm[] searchTerms) throws NXException, RemoteException
SearchTerm
s from the recipe and deletes them.
searchTerms
- NXException
RemoteException
void setSearchTermLogic(SearchTerm.SearchTermLogicType logicType, SearchTerm[] searchTerms) throws NXException, RemoteException
SearchTerm
s passed in.
logicType
- searchTerms
- NXException
RemoteException
void setSearchOptionValue(String optionSet, String searchOption, boolean optionValue) throws NXException, RemoteException
getAllSearchOptionSets()
to get all the option set internal names defined in database.
Use getAllSearchOptions(java.lang.String)
to get all the search option internal names defined in database.
optionSet
- searchOption
- optionValue
- NXException
RemoteException
boolean getSearchOptionValue(String optionSet, String searchOption) throws NXException, RemoteException
getAllSearchOptionSets()
to get all the option set internal names defined in database.
Use getAllSearchOptions(java.lang.String)
to get all the search option internal names defined in database.
optionSet
- searchOption
- NXException
RemoteException
String[] getAllSearchOptions(String optionSet) throws NXException, RemoteException
getAllSearchOptionSets()
to get all the option sets internal name defined in database.
optionSet
- NXException
RemoteException
String[] getAllSearchOptionSets() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.