|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.epm.util.EPMQueryHelper
The EPMQueryHelper class provides set of static methods to help
with performing queries and manipulating their results.
Supported API: false
Extendable: false
Field Summary | |
private static int |
CHUNK_SIZE
|
private static String |
CLIENT_QUERY_HELPER_CLASS
|
private static Class |
clientQueryHelperClaz
|
private static String |
CONFIGSPEC_OBJECT_KEY
|
static Object |
EDIT_IBAS
|
private static String |
RESOURCE
|
Constructor Summary | |
EPMQueryHelper()
|
Method Summary | |
static void |
addCheckedOutFilterToQuerySpec(QuerySpec select,
Class workableClass,
int workableIndex,
EPMWorkspace ws)
|
protected static int |
addLinkCondition(QuerySpec qs,
Class linkCl,
long[] ids)
|
static void |
addModifiedFilterToQuerySpec(QuerySpec select,
Class workableClass,
int workableIndex,
boolean modified,
EPMWorkspace ws)
|
static void |
addModifiedInSBFilterToQuerySpec(QuerySpec select,
Class iteratedClass,
int iteratedIndex,
boolean modified)
|
static ObjectIdentifier |
assignUniqueIdentifier(Persistable object)
|
static WhereExpression |
buildExpression(Class objectClass,
String attribute,
long[] databaseIds)
Builds a where expression for the query based on an array of database identifiers. |
static void |
copyAndSaveEPMSepFamilyTables(Collection familyTablesToCopy,
Collection moveLinksFor,
ConfigSpec configSpec)
This method clones and stores FamilyTable including all it's containedIn links and returns new FamilyTable |
private static SearchCondition |
createInSearchCondition(Class targetClass,
String attribute,
long[] value)
|
private static SearchCondition |
createInSearchCondition(Class targetClass,
String attribute,
long[] value,
boolean negate)
|
static QueryResult |
difference(QueryResult firstSet,
QueryResult secondSet)
Returns a QueryResult that contains all of the objects that are in the first set but are not in the second set. |
static long[] |
extractBranchIds(Collection objects)
Extracts the branch identifier from each object in the collection of Iterated objects or VersionForeignKeys. |
static long[] |
extractBranchIds(WTCollection objects,
Class[] classes,
boolean includeSubClasses)
Returns the branch identifier for each object in the collection that is an instance of one of the given classes. |
static long[] |
extractIds(Collection objects)
Extracts the database identifier from each object in the collection of Persistable objects or ObjectIdentifiers. |
static long[] |
extractIds(Collection persistables,
Map persistablesById)
|
static long[] |
extractIDs(ObjectIdentifier[] objectIDs,
Class objectClass)
|
static long[] |
extractIds(WTCollection objects,
Class[] classes,
boolean includeSubClasses)
Returns the database identifier for each object in the collection that is an instance of one of the given classes. |
static long[] |
extractMasterIds(Collection objects)
Extracts the database identifier of the Master of each object in the collection of Iterated objects removing duplicates. |
static QueryResult |
extractObjects(QueryResult arrays,
Class objectClass)
Given a query result of arrays, extracts the object of the given class from each array. |
static QueryResult |
extractObjects(QueryResult arrays,
int index)
Given a query result of arrays, extracts the object at the given index from each array. |
private static long[] |
familyTables2familyTableMasterIds(Collection familyTables)
|
static QueryResult |
familyTablesDocListDifference(EPMWorkspace ws,
Collection familyTables,
Collection docs,
boolean checkedoutOnly,
Boolean modified)
This method returns list of documents from the Family Tables which do not present in the collection of docs |
static Collection |
familyTablesDocListDifferenceCollection(EPMWorkspace ws,
Collection familyTables,
Collection docs,
boolean checkedoutOnly,
Boolean modified)
This method do the same thing as familyTablesDocListDifference but returns Collection of EPMDocument-s instead of QueryResult |
static QueryResult |
filterObjects(QueryResult objects,
Class classToKeep)
Given a query result of objects, filters out all objects except those of the given class from the query result. |
private static int |
findIndex(Object[] array,
Class objectClass)
|
static QueryResult |
findObjects(ObjectIdentifier[] objectIDs)
Retrieves Persistable objects from the database given their object identifiers. |
static QueryResult |
getBuildRules(Iterated object)
|
private static Object |
getKey(Object object)
|
static QueryResult |
getLatestCompatible(QueryResult originals)
Gets latest compatible objects from a query result of Persistable objects. |
static QueryResult |
getLatestCompatible(QueryResult originals,
WTContainerRef preferedContainerRef)
Gets latest compatible objects from a query result of Persistable objects. |
protected static void |
getLatestCompatibleInstance(long[] masterOIDs,
long[] familyTableOIDs,
Map instances)
|
private static QuerySpec |
getOnlyInstancesRestriction()
|
static QueryResult |
getPreviousContainedInLinksAndStuff(Collection famTables,
long[] docIds)
|
static String |
getType(QueryResult result)
|
static void |
initializeRoles(QueryResult links,
QueryResult objects)
Initializes the RoleA and RoleB members for each link using the objects provided in the other QueryResult. |
static boolean |
isArrays(QueryResult result)
Given a query result, determine whether or not it contains arrays. |
static boolean |
isLaterIteration(Iterated first,
Iterated second)
Compares two Iterated objects of same Master and returns true if the first Iteration is later than the second. |
static HashMap |
lookupAttrDefs(String[] attrDefNames)
|
static ConfigSpec |
lookupConfigSpec(EPMWorkspace workspace)
|
static QueryResult |
lookupContainedInLinks(Collection familyTables,
ConfigSpec configSpec)
This method returns list of documents from the Family Tables which do not present in the collection of docs |
static QueryResult |
lookupContainedInLinksAndFamilyTablesForMemberAndCheckOtherCheckouts(Collection docs,
EPMWorkspace ws)
|
static List |
lookupContainers(String[] containerNames)
|
static Map |
lookupDependencyLinks(List documents,
boolean getDocuments,
ConfigSpec configSpec)
|
static QueryResult |
lookupDocuments(Collection documents,
ConfigSpec configSpec,
EPMWorkspace ws)
|
static QueryResult |
lookupDocuments(Vector docs,
ConfigSpec configSpec,
EPMWorkspace ws)
|
static QueryResult |
lookupFamilyTableCells(Collection containedInLinks)
|
static QueryResult |
lookupFamilyTableColumns(Collection familyTables)
|
static QueryResult |
lookupFamilyTableColumns(long[] familyTableIds)
|
static QueryResult |
lookupFamilyTableMembers(Collection familyTables,
ConfigSpec configSpec)
|
static QueryResult |
lookupFamilyTables(Collection members,
EPMWorkspace workspace)
|
private static QueryResult |
lookupFamilyTables(long[] ids,
EPMWorkspace workspace,
boolean returnLink,
boolean returnDocId)
|
static Map |
lookupFamilyTablesAndLinkByMembers(Collection members,
EPMWorkspace workspace)
|
static Map |
lookupFamilyTablesByMembers(Collection members,
EPMWorkspace workspace)
|
static Collection |
lookupFamilyTablesForMembers(Collection members)
|
static QueryResult |
lookupFeatureDefinitions(Collection familyTables)
|
static Map |
lookupGenerics(Collection instances,
ConfigSpec configSpec)
Method returns Map where key is instance CADName and value is correspondent generic EPMDocument |
static IBAHolder[] |
lookupIBAs(Collection holderList)
|
static IBAHolder[] |
lookupIBAs(IBAHolder[] holders)
Given an array of IBAHolders, this method queries windchill database and gets values of all attributes with constraints. |
static QueryResult |
lookupInstancesAndContainedInLinks(Collection familyTables,
ConfigSpec configSpec)
|
static QueryResult |
lookupInstancesAndContainedInLinks(QueryResult familyTables,
ConfigSpec configSpec)
|
static Map |
lookupLatestCompatibleFamilyTableMemberIterations(Collection memberMasters,
Collection familyTables)
Returns a map the latest instances of given masters compatible with the given family tables, where : key is a instance value is a link. |
static QueryResult |
lookupMembersAndContainedInLinks(Collection familyTables,
ConfigSpec configSpec)
|
static QueryResult |
lookupMembersAndContainedInLinks(QueryResult familyTables,
ConfigSpec configSpec)
|
private static QueryResult |
lookupMembersAndContainedInLinks(QueryResult familyTables,
ConfigSpec configSpec,
QuerySpec querySpec)
|
static Map |
lookupOrganizations(Collection orgNames)
|
static Map |
lookupOrganizations(String[] orgNames)
|
static QueryResult |
lookupParameterDefinitions(Collection familyTables)
|
static QueryResult |
lookupParamMaps(Collection ibaHolders)
|
static EPMDocument |
lookupTopGeneric(EPMFamilyTable familyTable)
|
static List |
lookupTopGeneric(List familyTables)
|
static QueryResult |
lookupTopGenericAndContainedInLink(Collection familyTables,
ConfigSpec configSpec)
|
static QueryResult |
lookupTopGenericAndContainedInLink(QueryResult familyTables,
ConfigSpec configSpec)
|
static QueryResult |
lookupVariantLinks(Collection instances,
boolean onlyOtherSide,
ConfigSpec configSpec)
|
static QueryResult |
lookupVariantLinks(Collection instances,
ConfigSpec configSpec)
|
static QueryResult |
lookupVariantLinks(QueryResult instances,
boolean onlyOtherSide,
ConfigSpec configSpec)
|
static QueryResult |
lookupVariantLinks(QueryResult instances,
ConfigSpec configSpec)
|
static EPMWorkspace |
lookupWorkspace(String name)
|
static EPMWorkspace |
lookupWorkspace(String name,
WTPrincipal owner)
|
static QueryResult |
removeDuplicates(QueryResult originals)
Removes duplicates from a query result of Persistable objects or ObjectIdentifiers. |
static QueryResult |
sandboxFamilyTablesDocListDifference(WTContainerRef sandboxContainerRef,
Collection familyTables,
Collection docs,
Boolean modifiedInSandBox)
This method returns list of documents from the Family Tables which do not present in the collection of docs |
static Collection |
selectLatestIteration(Collection originals)
Given a collection of Iterated and Mastered objects, return the latest iterations for each set of iterations in the collection that share the same master. |
static Object[] |
toArray(QueryResult objects,
Class objectClass)
Returns an array of type objectClass that contains all of the objects in the supplied QueryResult. |
private static long[] |
trimArray(long[] array,
int newLength)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private static final String RESOURCE
private static int CHUNK_SIZE
private static final String CONFIGSPEC_OBJECT_KEY
public static final Object EDIT_IBAS
private static Class clientQueryHelperClaz
private static String CLIENT_QUERY_HELPER_CLASS
Constructor Detail |
public EPMQueryHelper()
Method Detail |
public static QueryResult extractObjects(QueryResult arrays, int index)
public static QueryResult extractObjects(QueryResult arrays, Class objectClass)
public static QueryResult filterObjects(QueryResult objects, Class classToKeep)
public static boolean isArrays(QueryResult result)
public static Object[] toArray(QueryResult objects, Class objectClass)
public static QueryResult removeDuplicates(QueryResult originals)
public static QueryResult getLatestCompatible(QueryResult originals) throws WTException
WTException
public static boolean isLaterIteration(Iterated first, Iterated second) throws WTException
WTException
public static QueryResult findObjects(ObjectIdentifier[] objectIDs) throws WTException
WTException
public static QueryResult difference(QueryResult firstSet, QueryResult secondSet)
public static void initializeRoles(QueryResult links, QueryResult objects)
public static long[] extractIds(Collection objects)
public static long[] extractIds(WTCollection objects, Class[] classes, boolean includeSubClasses) throws WTException
WTException
public static long[] extractMasterIds(Collection objects)
public static long[] extractBranchIds(Collection objects)
public static long[] extractBranchIds(WTCollection objects, Class[] classes, boolean includeSubClasses) throws WTException
WTException
public static WhereExpression buildExpression(Class objectClass, String attribute, long[] databaseIds) throws WTException
WTException
public static String getType(QueryResult result)
private static int findIndex(Object[] array, Class objectClass)
public static long[] extractIDs(ObjectIdentifier[] objectIDs, Class objectClass)
private static Object getKey(Object object)
private static long[] trimArray(long[] array, int newLength)
public static QueryResult getLatestCompatible(QueryResult originals, WTContainerRef preferedContainerRef) throws WTException
WTException
public static Collection selectLatestIteration(Collection originals) throws WTException
WTException
public static EPMWorkspace lookupWorkspace(String name, WTPrincipal owner) throws WTException
WTException
public static EPMWorkspace lookupWorkspace(String name) throws WTException
WTException
public static ConfigSpec lookupConfigSpec(EPMWorkspace workspace) throws WTException
WTException
public static QueryResult lookupDocuments(Collection documents, ConfigSpec configSpec, EPMWorkspace ws) throws WTException
WTException
public static QueryResult lookupDocuments(Vector docs, ConfigSpec configSpec, EPMWorkspace ws) throws WTException
WTException
public static QueryResult lookupFamilyTables(Collection members, EPMWorkspace workspace) throws WTException
WTException
public static Collection lookupFamilyTablesForMembers(Collection members) throws WTException
WTException
public static Map lookupFamilyTablesByMembers(Collection members, EPMWorkspace workspace) throws WTException
WTException
public static Map lookupFamilyTablesAndLinkByMembers(Collection members, EPMWorkspace workspace) throws WTException
WTException
public static long[] extractIds(Collection persistables, Map persistablesById) throws WTException
WTException
private static QueryResult lookupFamilyTables(long[] ids, EPMWorkspace workspace, boolean returnLink, boolean returnDocId) throws WTException
WTException
public static QueryResult lookupContainedInLinksAndFamilyTablesForMemberAndCheckOtherCheckouts(Collection docs, EPMWorkspace ws) throws WTException
WTException
public static Collection familyTablesDocListDifferenceCollection(EPMWorkspace ws, Collection familyTables, Collection docs, boolean checkedoutOnly, Boolean modified) throws WTException
WTException
public static QueryResult familyTablesDocListDifference(EPMWorkspace ws, Collection familyTables, Collection docs, boolean checkedoutOnly, Boolean modified) throws WTException
WTException
private static SearchCondition createInSearchCondition(Class targetClass, String attribute, long[] value) throws WTException
WTException
private static SearchCondition createInSearchCondition(Class targetClass, String attribute, long[] value, boolean negate) throws WTException
WTException
public static QueryResult sandboxFamilyTablesDocListDifference(WTContainerRef sandboxContainerRef, Collection familyTables, Collection docs, Boolean modifiedInSandBox) throws WTException
WTException
public static QueryResult lookupContainedInLinks(Collection familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupFamilyTableMembers(Collection familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupInstancesAndContainedInLinks(Collection familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupInstancesAndContainedInLinks(QueryResult familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupTopGenericAndContainedInLink(Collection familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupTopGenericAndContainedInLink(QueryResult familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupMembersAndContainedInLinks(Collection familyTables, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupMembersAndContainedInLinks(QueryResult familyTables, ConfigSpec configSpec) throws WTException
WTException
private static QueryResult lookupMembersAndContainedInLinks(QueryResult familyTables, ConfigSpec configSpec, QuerySpec querySpec) throws WTException
WTException
private static QuerySpec getOnlyInstancesRestriction() throws WTException
WTException
public static Map lookupLatestCompatibleFamilyTableMemberIterations(Collection memberMasters, Collection familyTables) throws WTException
WTException
protected static void getLatestCompatibleInstance(long[] masterOIDs, long[] familyTableOIDs, Map instances) throws WTException
WTException
public static QueryResult lookupFamilyTableCells(Collection containedInLinks) throws WTException
WTException
public static QueryResult lookupFamilyTableColumns(Collection familyTables) throws WTException
WTException
public static QueryResult lookupFamilyTableColumns(long[] familyTableIds) throws WTException
WTException
private static long[] familyTables2familyTableMasterIds(Collection familyTables) throws WTException
WTException
public static QueryResult lookupParameterDefinitions(Collection familyTables) throws WTException
WTException
public static QueryResult lookupFeatureDefinitions(Collection familyTables) throws WTException
WTException
public static QueryResult lookupVariantLinks(Collection instances, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupVariantLinks(Collection instances, boolean onlyOtherSide, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupVariantLinks(QueryResult instances, ConfigSpec configSpec) throws WTException
WTException
public static QueryResult lookupVariantLinks(QueryResult instances, boolean onlyOtherSide, ConfigSpec configSpec) throws WTException
WTException
public static Map lookupGenerics(Collection instances, ConfigSpec configSpec) throws WTException
instances
- configSpec
-
WTException
public static Map lookupDependencyLinks(List documents, boolean getDocuments, ConfigSpec configSpec) throws WTException
WTException
protected static int addLinkCondition(QuerySpec qs, Class linkCl, long[] ids) throws WTException
WTException
public static IBAHolder[] lookupIBAs(Collection holderList) throws WTException
WTException
public static IBAHolder[] lookupIBAs(IBAHolder[] holders) throws WTException
WTException
public static HashMap lookupAttrDefs(String[] attrDefNames) throws WTException
WTException
public static List lookupContainers(String[] containerNames) throws WTException
WTException
public static Map lookupOrganizations(Collection orgNames) throws WTException
WTException
public static Map lookupOrganizations(String[] orgNames) throws WTException
WTException
public static EPMDocument lookupTopGeneric(EPMFamilyTable familyTable)
public static List lookupTopGeneric(List familyTables)
public static QueryResult getBuildRules(Iterated object) throws WTException
WTException
public static ObjectIdentifier assignUniqueIdentifier(Persistable object) throws WTException
WTException
public static void addModifiedFilterToQuerySpec(QuerySpec select, Class workableClass, int workableIndex, boolean modified, EPMWorkspace ws) throws WTException
select
- workableClass
- workableIndex
- modified
- - if true query will return only modified objects if false only not modified
WTException
public static void addCheckedOutFilterToQuerySpec(QuerySpec select, Class workableClass, int workableIndex, EPMWorkspace ws) throws WTException
WTException
public static void addModifiedInSBFilterToQuerySpec(QuerySpec select, Class iteratedClass, int iteratedIndex, boolean modified) throws WTException
WTException
public static void copyAndSaveEPMSepFamilyTables(Collection familyTablesToCopy, Collection moveLinksFor, ConfigSpec configSpec) throws WTException, WTPropertyVetoException
familyTablesToCopy
- - Collection of EPMSepFamilyTables that must be cloned
WTException
WTPropertyVetoException
public static QueryResult getPreviousContainedInLinksAndStuff(Collection famTables, long[] docIds) throws WTException
WTException
public static QueryResult lookupParamMaps(Collection ibaHolders) throws WTException
WTException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |