windchill开发笔记

windchill开发中用到的各种API及知识点

1.关于树结构的节点展示问题:

在xml树结构的构建中,通常使用如下代码来进行树节点的展示

//节点展示级别(full,one,none),可以写String,但推荐使用资源文件
treeConfig.setExpansionLevel(DescriptorConstants.TableTreeProperties.NO_EXPAND);
//异步加载
((JcaTreeConfig) treeConfig).setDataSourceMode(DataSourceMode.ASYNCHRONOUS);

异步树加载和同步树加载的区别在于,是否实现TreeDataBuilderAsync这个接口,实现了这个接口后,在builder中就必须要实现buildNodeData这个方法.

2.获取xml文件中每一个节点的数据

在windchill读取xml文件时,首先是通过Provider来与xml文件进行接触,先通过xml文件的根节点来获取所有的父节点,再通过父节点来获取所有子节点,再通过节点中标签的属性值来获取节点对应的数据.

//首先windchill会根据handler来读取父节点的key,value.
@Override
    public List<Object> getRootNodes() {
        ArrayList<Object> rootList = new ArrayList<>();
		//获取除根节点外的最大父节点
        List<Element> xmlRoots = provider.getAllRoots();
        for (Element element : xmlRoots) {
            String attribute = element.getAttribute("name");
            rootList.add(new MyXmlDataBean(attribute, element));
        }
        return rootList;
    }
   	//调用provider中的getRootNodes的方法后,在这个方法里会获得所有的父节点,这个方法中又调用了一个方法getAllRoots,就是遍历父节点的里的每个tag
   	/**
     * 根节点
     *
     * @return
     */
    public List<Element> getAllRoots() {
        ArrayList<Element> rootNodes = new ArrayList<>();
        if (document == null) {
            logger.debug("-----error-----");
        }
        //拿到根节点
        NodeList nodeList = this.document.getElementsByTagName("root");
        int length = nodeList.getLength();
        logger.debug(length);
        for (int i = 0; i < length; i++) {
            Node rootNode = nodeList.item(i);
            if (rootNode instanceof Element) {
                //再根据刚刚拿到的父节点去找父节点
                rootNodes.addAll(findChildren(rootNode));
            }
        }
        return rootNodes;
    }

public List<Element> findChildren(Node parentNode) {
        ArrayList<Element> childNodes = new ArrayList<>();
        if (parentNode != null) {
        	//拿到根节点中的所有父节点
            NodeList childList = parentNode.getChildNodes();
            int length = childList.getLength();
            for (int i = 0; i < length; i++) {
                Node childNode = childList.item(i);
                if (childNode instanceof Element) {
                    childNodes.add((Element) childNode);
                }
            }
        }
        return childNodes;
    }
    //全部父节点都拿到以后,再去getRootNodes这个方法中获得父节点对应的key,value.
    //最后才会根据父节点的集合,去获取父节点里所有子节点的数据
    @Override
    public Map<Object, List> getNodes(List list) {
        HashMap<Object, List> map = new HashMap<>();

        for (Object object : list) {
            ArrayList<Object> childList = new ArrayList<>();
            if (object instanceof MyXmlDataBean) {
                MyXmlDataBean bean = (MyXmlDataBean) object;
                List<Element> childElements = provider.findChildren(bean.getNode());
                for (Element child : childElements) {
                    String attribute = child.getAttribute("name");
                    childList.add(new MyXmlDataBean(attribute, child));
                }
            }
            map.put(object, childList);
        }
        return map;
    }

3.常用API-绕过权限

SessionServerHelper.manager.setAccessEnforced(boolean)

4.DataUtility属性联动-js绑定

comboBox.addJsAction("onChange", "refreshCitiesByProvince('" + ChinaCityInfoPath.PROVINCE + "','" + ChinaCityInfoPath.CITY + "','" + ChinaCityInfoPath.DISTRICT + "')");

5.通过Filter中的参数获得容器对象和actionName及ObjType

 //获得上下文对象
WTReference contextObject = uiValidationCriteria.getContextObject();
 //拿到持久化对象
Persistable pobj = contextObject.getObject();
//获得按钮定义
String actionName = uiValidationKey.getComponentID();
//获得objectType
String objectType = uiValidationKey.getObjectType();

6.获取当前登录用户及给定角色规则

//当前用户
WTUser user = (WTUser) SessionHelper.getPrincipal();
//角色规则
Role role = Role.toRole("DESIGN ENGINEER");

7.判断用户是否属于容器下的某个角色

PIContainerHelper.service.isRolePrincipal((ContainerTeamManaged) container,role,user);

8.拿到最新版本的文档

PIDocumentHelper.service.findWTDocument(document.getNumber());

9.判断用户是否属于容器下的某个角色

PIContainerHelper.service.isRolePrincipal((ContainerTeamManaged) container,role,user);

10.NmCommandBean中使用到的方法

//获得当前语言环境
Locale locale = commandBean.getLocale();
//拿到文本框
HashMap textMap = commandBean.getText();
//获取当前容器
WTContainerRef containerRef = commandBean.getContainerRef();
//拿到当前对象的类型
NmOid actionOid = commandBean.getActionOid();

11.在当前容器下创建子文件夹

SubFolder subFolder = FolderHelper.service.createSubFolder(folderPathAndName, containerRef);

12.获取持久化对象的url路径

String url = PartManagementHelper.getInfoPageURL(subFolder);

13.获取上传文件,map中可能是文件数组

 HashMap<String, Object> fileUploadMap = (HashMap<String, Object>) commandBean.getMap().get("fileUploadMap");

14.获取页面的查询参数值或隐藏输入字段的值（单个值）

String secondFiles = commandBean.getTextParameter("secondFiles");

15.在当前容器下创建子文件夹

SubFolder subFolder = FolderHelper.service.createSubFolder(folderPathAndName, containerRef);

16.更新目标附件

//传入参数1.更新对象  2.更新数据 3.更新io流
ContentServerHelper.service.updateContent(holder, applicationData, inputStream);

17.更新部件文档编号名称注意条件

在更新部件,文档编号名称时要注意是通过对象的Master类来更新的

WTDocumentMasterIdentity masterIdentity = (WTDocumentMasterIdentity) master.getIdentificationObject();

18.修改对象编号,名称时调用的API

(WTDocumentMaster) IdentityHelper.service.changeIdentity(master, masterIdentity);

19.自刷新

(WTDocument) PersistenceHelper.manager.refresh(document);

20.删除目标主内容

ContentServerHelper.service.deleteContent(doc, primaryContent);

21.更新目标格式

doc.setFormat(primaryContent.getFormat());
PersistenceServerHelper.manager.update(doc);

22.获取ContentHolder对象

ContentHolder holder = ContentHelper.service.getContents(doc);

23.通过ContentHolder及规则获取主要内容

ContentHelper.service.getContentsByRole(holder, ContentRoleType.PRIMARY);

24.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

25.通过filter中的参数拿上下文容器

WTReference contextObject = uiValidationCriteria.getContextObject();
//拿到持久化对象
Persistable pobj = contextObject.getObject();
//判断对象是否包含文件夹类型
SubFolder folder = (SubFolder) pobj;

26.获取对象的iba属性值

//第一个参数  查询对象
//第二个参数  iba内部值
String value = (String) PIAttributeHelper.service.getValue(folder, "createFolder");

27.获取当前文件夹下所有的对象

//参数  需要查询的文件夹
QueryResult qr = PIContainerHelper.service.findFolderContents(folder);
        while (qr.hasMoreElements()) {
            Object nextElement = qr.nextElement();
            if (nextElement instanceof SubFolder) {
                SubFolder sonFolder = (SubFolder) nextElement;
            }
        }

28.获取对象大版本的最新小版本

//参数1 获取对象  参数2 
part = (WTPart) VersionControlHelper.service.getLatestIteration(part, true);

29.获取给定的版本管理对象的最新大版本的最新小版本

//参数1 获取对象	
Iterated latest = PICoreHelper.service.getLatestIterationOfLatestVersion(part);
                    if (latest instanceof WTPart) {
                        part = (WTPart) latest;
                    }

30.获取相关对象的方法

31.查询当前部件的子件

 WTCollection children = PIPartHelper.service.findChildren(part);

32.根据部件的视图类型和编号查询部件

part = PIPartHelper.service.findWTPart(part.getNumber(), (View) (part.getView().getObject()));

33.返回当前主体的WTPartConfigSpec

WTPartConfigSpec config = WTPartHelper.service.findWTPartConfigSpec();
//(视图,生命周期)
WTPartStandardConfigSpec standard = config.getStandard();

34.根据对象和对象的标准配置查询相关的link和master

//param1 部件   param2  部件标准配置属性
//这里是根据之前的部件视图配置,来查询Design视图的关联部件,如果有design视图的关联部件,则是有link的,不是design视图但link的部件,则查询出来的是对应的master
QueryResult qr = WTPartHelper.service.getUsesWTParts(pop, standard);
		while (qr.hasMoreElements()) {
                Persistable[] persistables = (Persistable[]) qr.nextElement();
                // 获取到WTPartUsageLink对象
                Persistable childPersistable = persistables[1];
                WTPart child;
                if (childPersistable instanceof WTPart) {
                    child = (WTPart) childPersistable;
                    childBeans.add(child);
                }else if (childPersistable instanceof WTPartMaster){
                    throw new WTException("M视图的部件不支持挂入D视图下");
                }
            }

35.通过部件获得部件的内部名称的最后一段

String partType = PICoreHelper.service.getSimpleTypeName(part);

36.通过分类的内部值,获取当前分类的整个分类树结构

Collection<String> childClassification =PIClassificationHelper.service.getChildrenNodeNames(valueF);

37.存储link关系

//param1  link对象  param2  master对象
WTPartSubstituteLink newWTPartSubstituteLink = wt.part.WTPartSubstituteLink.newWTPartSubstituteLink(link, wtPart.getMaster());
PersistenceServerHelper.manager.insert(newWTPartSubstituteLink);

38.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

39.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

40.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

41.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

42.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

43.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

44.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

45.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

46.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

47.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

48.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

49.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);

50.通过部件获得跟部件相关联的CAD文档集合

Collection<AssociationLinkObject> epmAndLinks = PartDocServiceCommand.getAssociatedCADDocumentsAndLinks(wtPart);