Package com.ptc.windchill.esi.map

Class ESIMapper

java.lang.Object
com.ptc.windchill.esi.map.ESIMapper
public final class ESIMapper extends Object


Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    com.infoengine.object.factory.Element
    map(com.infoengine.object.factory.Element inputElement, ESIMap map)
    This method creates a mapped Info*Engine Element object from another Info*Engine Element object.
    com.infoengine.object.factory.Element
    map(com.infoengine.object.factory.Element inputElement, ESIMap map, boolean includeEmptyAttributes)
    This method creates a mapped Info*Engine Element object from another Info*Engine Element object.
    com.infoengine.object.factory.Element
    map(com.infoengine.object.factory.Element inputElement, Persistable persistedObject, ESIMap map)
    This method creates a mapped Info*Engine Element object from another Info*Engine Element object.
    com.infoengine.object.factory.Element
    map(Object object, ESIMap map)
    This method creates a mapped Info*Engine Element object from the Object argument.
    com.infoengine.object.factory.Element
    map(Object object, ESIMap map, Map businessFields)
    This method creates a mapped Info*Engine Element object from the Object argument.An additional parameter businessFields is passed to the method.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • map

      public com.infoengine.object.factory.Element map(Object object, ESIMap map) throws WTException
      This method creates a mapped Info*Engine Element object from the Object argument.

      Supported API: true
      Parameters:
      object - The object to be mapped.
      map - The ESIMap to use for the mapping.
      Returns:
      Element
      Throws:
      WTException

    • map

      public com.infoengine.object.factory.Element map(Object object, ESIMap map, Map businessFields) throws WTException
      This method creates a mapped Info*Engine Element object from the Object argument.An additional parameter businessFields is passed to the method. This map will be populated with all those attributes that do not have a getter method.

      Supported API: true
      Parameters:
      object - The object to be mapped.
      map - The ESIMap to use for the mapping.
      Returns:
      Element
      Throws:
      WTException

    • map

      public com.infoengine.object.factory.Element map(com.infoengine.object.factory.Element inputElement, ESIMap map) throws WTException
      This method creates a mapped Info*Engine Element object from another Info*Engine Element object.

      Supported API: true
      Parameters:
      inputElement - The element to be mapped.
      map - The ESIMap to use for mapping.
      Returns:
      Element
      Throws:
      WTException

    • map

      public com.infoengine.object.factory.Element map(com.infoengine.object.factory.Element inputElement, ESIMap map, boolean includeEmptyAttributes) throws WTException
      This method creates a mapped Info*Engine Element object from another Info*Engine Element object. Empty attributes will not be included in the returned element if the boolean "includeEmptyAttributes" is false. If true, this method's behavior is identical to that of map(Element, ESIMap) API.

      Supported API: true
      Parameters:
      inputElement - - The element to be mapped.
      map - - The ESIMap to use for mapping.
      includeEmptyAttributes - - If false, the output element doesn't contain the empty attributes.
      Returns:
      Element
      Throws:
      WTException

    • map

      public com.infoengine.object.factory.Element map(com.infoengine.object.factory.Element inputElement, Persistable persistedObject, ESIMap map) throws WTException
      This method creates a mapped Info*Engine Element object from another Info*Engine Element object. It the source Element object does not have the value specified in Source_Name of the map file entry, the mapper attempts to obtain the value from the Persistable object in the second method argument.

      Supported API: true
      Parameters:
      inputElement - The I*E element that the attributed will be added.
      persistedObject - The persisted object that contains the attributes to add to the element.
      map - The mapfile to use to get the requested attributes to add to the element.
      Returns:
      Element
      Throws:
      WTException