ToolUtils

Object
- ToolUtils

All Implemented Interfaces:

RemoteAccess
```
public class ToolUtils
extends Object
implements RemoteAccess
```
collection of a few useful methods to help with windchill/IE

Author:

mkraegeloh

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HTTPGWHOSTNAME`
`static int`	`MAJOR`
`static int`	`MINOR`
`static Pattern`	`NONALPHANUM`
`static String`	`RMIHOSTNAME`
`static boolean`	`SERVER`
`static String`	`WEBAPPNAME`
`static String`	`WTHOME`

Fields inherited from interface RemoteAccess
versionID

Constructor Summary

Constructors
Constructor and Description

ToolUtils()

Constructors
Constructor and Description
`ToolUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`_delete(String[] as)` server side part of delete()
`static void`	`_update(Persistable p)`
`static void`	`_update(WTCollection w)` server side part of update method.
`static Group`	`callTask(Hashtable formHash, Group serverGroup, String myTaskName)` short form of callTask
`static Group`	`callTask(Hashtable formHash, Group serverGroup, String myTaskName, Hashtable params)` Prepare and invoke an InfoEngine Task.
`static Hashtable`	`callTask(Hashtable formHash, Group serverGroup, String myTaskName, Hashtable params, Boolean onlyDefault)` Prepare and invoke an InfoEngine Task.
`static Group`	`callTask(Persistable pbo, String myTaskName)` workflow form of callTask
`static Connection`	`dbConnect()` connect to configured database and return connection object
`static void`	`delete(String[] as)` brute force remove obj with server side method.
`static void`	`deser(String[] argv)` deserialize an object from a file and dump it to stdout
`static void`	`deserex(String[] argv)` deserialize the base64 encoded text given in argv into an object and either print a stacktrace (if it's an exception) or dump it to stdout typical use to get a stacktrace for the exception message in an I*E error group
`static void`	`deserLA(String[] argv)` deserialize an object from a file and dump it to stdout
`static void`	`dumpGroup(Group wt_group)` class to call dump of first element of group passed in.
`static void`	`dumpGroup(Group g, int many)` class to dump a number of elements of group passed in.
`static Map<String,Object>`	`element2Hash(Element in)` make a hashtable from an Element
`static String`	`escapeXML(Object o)` escape xml (or html) special chars & > < " ' with their textual representation e.g.
`static String`	`extractMessage(Group g)` extract from a (typically @SERVER) group the innermost exception-message
`static String`	`extractMessage(Group g, Logger logger1)` extract from a (typically @SERVER) group the innermost exception-message
`static Object`	`f2o(String f)` deserialize an object from a file.
`static String`	`fixEscapes(String a)` return string with occurences of %hh (hh being two hex digits) replaced with the character represented by hex value.
`static void`	`fixEscapes(String[] a)` call fixEscapes for all strings in an array.
`static void`	`fixEscapes(String a, StringBuffer b)` replaces all occurrences of %hh (hh being two hex digits) with the character represented by hex value VR%3Awt.doc.WTDocument%3A423428 -> VR:wt.doc.WTDocument:423428 currently provides no way to escape the % except with %25
`static Group`	`fixObid(Group in)` make obid atts in group contain only the short obid for wt so we loop and change all values of atts named obid or masterReference
`static Group`	`fixObid(Group in, String[] fixNames, boolean complain)` make obid atts in group contain only the short obid for wt so we loop and change all values of atts in String[] fixNames
`static void`	`formatFloatToInt(Group g, String[] cols)` try to reformat the value[s] into integers
`static int[]`	`getIntVersion(Class toCheck)` return an int array with major and minor version number
`static String`	`getOR(Object p)` return an obid for the object, of the obj is a Persistable and persisted gives normal OR:class:ida2a2 obid.
`static String`	`getOR(Persistable p)` return a Persistable's OR: obid
`static String`	`getRevString(Persistable perObj)`
`static String`	`getStackTrace(Throwable aThrowable)`
`static String`	`getVersion(Class toCheck)` return major.minor version assumes the class to inspect has two public ints called MAJOR and MINOR
`static String`	`getVR(Iterated p)` return an iterated's VR: obid
`static String`	`getWidths(Group in)` return a string that will set the width for a display webject for all cols of a group to the max num of chars contained in each col. NOTE: as a sideeffect it checks and makes sure first element(=line) has all attributes occurring in elements 2..n, so display-table will work properly
`static Persistable`	`getWTObject(Object o)`
`static Persistable`	`getWTObjectByNumber(String objNumber, boolean getMaster)`
`static WTUser`	`getWTUserByName(String username)`
`static WTUser`	`getWTUserByName(String username, boolean ignorecase)`
`static WTUser`	`getWTUserByName(String username, boolean ignorecase, boolean throwException)`
`static WTUser`	`getWTUserByName(String username, boolean ignorecase, boolean useLike, boolean throwException)` get a wtuser obj by username.
`static String`	`group2csv(Group in, String fdelim, String rdelim, boolean includeHeaders)` make csv data from group
`static Map<String,Object>[]`	`group2HashArray(Group in)` return a group as an array of Hashtables filled with first att values, including com.infoengine.object.type meta (e.g., wt.part.WTPart)
`static Map<String,Object>[]`	`group2HashArray(Group in, boolean toLower)` return a group as an array of Hashtables filled with first att values, including com.infoengine.object.type meta (e.g., wt.part.WTPart)
`static Group`	`hash2Group(Hashtable h, String groupName)` Make an infoengine group from a hash table.
`static Group`	`hash2Group(Hashtable h, String groupName, String key, String value)` Make an infoengine group from a hash table, each key/value pair givng an element having a key and value att.
`static Group`	`hash2Group(Map h, String groupName)` Make an infoengine group from a hash table.
`static Group`	`hash2ParamGroup(Hashtable h, Hashtable f, String groupName)` prepare a form group from 2 hashes, one gives "normal" atts, the other makes atts of the form param=name=value
`static String`	`innerMessage(Throwable e)` return the message of an exception, if nested exceptions exist return the innermost message.
`static boolean`	`isAlphaNumeric(String text)`
`static boolean`	`isRequiredVersion(Class toCheck, int major, int minor, boolean throwEx)` return true if the required class has at least given major (and if major matches given minor version) assumes the class to inspect has two public ints called MAJOR and MINOR
`static boolean`	`isRoleMaster(String link, int roleoff)` tell caller if a links roleA or roleB object is a Master.
`static boolean`	`isValUnique(Group g, String col)` tell if a group's column contains the same value in all rows (e.g. verify all rows have the same value for att number)
`static String`	`jmxConn()`
`static Workable`	`latestVersionWrkObjFromObid(Object obid)` return the latest version of a persistable from an object (which via toString() must give an obid), return the working copy if the object is checked out.
`static void`	`logElement(Logger l, Element e)` log a group's xml to the log4j logger.
`static void`	`logException(Logger l, Throwable e)` log an exceptions stacktrace to the logger
`static void`	`logGroup(Logger l, Group g)` log a group's xml to the log4j logger.
`static void`	`logGroup(Logger l, Group g, String reason)` log a group's xml to the log4j logger.
`static Hashtable`	`lookupFromGroup(Group in, String key, String value)` return a lookup hash made from two cols of a group
`static void`	`main(String[] args)` main to invoke setting of state or test isRoleMaster().
`static void`	`mergeSelectedAtts(Group in, String key, Group from, String look, String[] use)` merge the atts from one group into the rows of a receiving group, using a value from the receiving group as key into group from will throw exception if the lookup key value is not present in "from" group.
`static void`	`meta2att(Group in, String meta, String attName)` adds normal Att for requested meta data
`static String`	`ne(Object o, Object... da)`
`static String`	`nn(Object o)` returns an empty string if passed null or an object's string representation
`static String`	`nn(Object o, Object... da)` returns a default string from varargs array (uses first non-null value) if passed null or an object's string representation
`static String`	`nn(Object o, String def)` returns a default string if passed null or an object's string representation
`static Object`	`nno(Object o)` returns an empty string if passed null or the object
`static String`	`nnx(Object s)` return nn with html escapes
`static String`	`nnx(Object s, String d)` return nn with html escapes
`static void`	`o2f(Object o, String s)` serialize an object to a file.
`static String`	`o2s(Object o)` serialize an object into a base64 string
`static String`	`objectInfo(Persistable obj)`
`static Persistable`	`objFromObid(Object obid)` return a persistable from an object (which via toString() must give an obid)
`static String`	`prettyPrint(boolean b)`
`static String`	`prettyPrint(byte b)`
`static String`	`prettyPrint(double b)`
`static String`	`prettyPrint(float b)`
`static String`	`prettyPrint(int b)`
`static String`	`prettyPrint(long b)`
`static String`	`prettyPrint(Object o)` simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output.
`static String`	`prettyPrint(Object o, boolean wantNL)` simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output.
`static String`	`prettyPrint(Object o, boolean wantNL, boolean includeMeta)` simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output.
`static String`	`prettyPrint(Object o, StringBuffer b, String indent, boolean wantNL)` print an object in a layout that allows to identify hases, vectors etc.
`static String`	`prettyPrint(Object o, StringBuffer b, String indent, boolean wantNL, boolean includeMeta)` print an object in a layout that allows to identify hases, vectors etc.
`static String`	`prettyPrint(short b)`
`static Group`	`readGroup(String s)` deserialize an infoengine group from a file.
`static void`	`removeAttNameTypePrefix(Group in, String[] names)` removes the type prefix in an att's name (e.g., wt.part.WTPartUsageLink.quantity.unit -> quantity.unit)
`static void`	`removeAttNameTypePrefix(Group in, String[] names, String tail)` removes the type prefix in an att's name (e.g., wt.part.WTPartUsageLink.quantity.unit -> quantity.unit)
`static boolean`	`rmDashR(File fOrD)` recursively delete file or directory
`static boolean`	`rmDashR(String fOrD)` recursively delete file or directory
`static void`	`rotGroup(Group in)` rotate group -> cols get rows, new col headers are row0 row1 etc.
`static Object`	`s2o(String s)` deserialize an object from a base64 string
`static void`	`saveGroup(Group g, String s)` serialize an infoengine group to a file.
`static void`	`setLC(String lcname, RevisionControlled r)` reassign lifecycle of an obj.
`static void`	`setStates(String[] args)` set the state of obid[s] passed in; if args[0] is "-l" then args[1] has lifecycle to assign to objs
`static String`	`shortObid(Object longObid)` extract the short ([OV]R:class.name:seqnr) obid from a ufid
`static String`	`shortObid(Object longObid, boolean throwException)` extract the short ([OV]R:class.name:seqnr) obid from a ufid
`static String`	`shortObid(String longObid)` Deprecated. Method shortObid(String) is deprecated, replaced by shortObid(Object).
`static String`	`shortObid(String longObid, boolean throwException)` Deprecated. Method shortObid(String ,boolean) is deprecated, replaced by shortObid(Object, boolean).
`static Group`	`subGroup(Group g, int skip, int n)` return part of a group (for paging? )
`static void`	`trimAtt(Group in, String attName)` walks a group's elements and trims whitespace from a given Att's value - IeDatum will be String afterwards.
`static String`	`unescapeXML(Object o)` escape xml (or html) special chars & > < " ' with their textual representation e.g.
`static void`	`update(Persistable p)`
`static void`	`update(WTCollection w)` calls server side update method on a given Persistable, bypassing checkin/checkout etc.
`static Workable`	`wrkObjFromObid(Object obid)` return a persistable from an object (which via toString() must give an obid), return the working copy if the object is checked out.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAJOR
```
public static final int MAJOR
```
    See Also:
    Constant Field Values
  - MINOR
```
public static final int MINOR
```
    See Also:
    Constant Field Values
  - RMIHOSTNAME
```
public static final String RMIHOSTNAME
```
  - HTTPGWHOSTNAME
```
public static final String HTTPGWHOSTNAME
```
  - WEBAPPNAME
```
public static final String WEBAPPNAME
```
  - WTHOME
```
public static final String WTHOME
```
  - SERVER
```
public static final boolean SERVER
```
  - NONALPHANUM
```
public static final Pattern NONALPHANUM
```
- Constructor Detail
  - ToolUtils
```
public ToolUtils()
```
- Method Detail
  - main
```
public static void main(String[] args)
                 throws Exception
```
    main to invoke setting of state or test isRoleMaster().
    
    Parameters:
    args -
    
    Throws:
    
    Exception
  - getVersion
```
public static String getVersion(Class toCheck)
```
    return major.minor version assumes the class to inspect has two public ints called MAJOR and MINOR
    
    Parameters:
    className -
    
    Returns:
    String x.y or 0.0 if no constants found
    Since:
    
    2.0
  - getIntVersion
```
public static int[] getIntVersion(Class toCheck)
```
    return an int array with major and minor version number
    
    Parameters:
    toCheck -
    
    Returns:
  - isRequiredVersion
```
public static boolean isRequiredVersion(Class toCheck,
                        int major,
                        int minor,
                        boolean throwEx)
                                 throws RuntimeException
```
    return true if the required class has at least given major (and if major matches given minor version) assumes the class to inspect has two public ints called MAJOR and MINOR
    
    Parameters:
    className -
    major -
    minor -
    
    Returns:
    true if class found is recent enough
    
    Throws:
    
    RuntimeException
    Since:
    
    2.0
  - dbConnect
```
public static Connection dbConnect()
                            throws Exception
```
    connect to configured database and return connection object
    
    Returns:
    
    Throws:
    
    Exception
  - setStates
```
public static void setStates(String[] args)
                      throws Exception
```
    set the state of obid[s] passed in; if args[0] is "-l" then args[1] has lifecycle to assign to objs
    
    Parameters:
    args -
    
    Throws:
    
    Exception
  - setLC
```
public static void setLC(String lcname,
         RevisionControlled r)
                  throws Exception
```
    reassign lifecycle of an obj.
    
    Parameters:
    lcname - the lifecycle name (to be resolved within r's container)
    r - the obj to receive the new lc
    
    Throws:
    
    Exception
  - rotGroup
```
public static void rotGroup(Group in)
```
    rotate group -> cols get rows, new col headers are row0 row1 etc. rot is done within group -> group gets altered!
    
    Parameters:
    in - group to rotate
  - getWidths
```
public static String getWidths(Group in)
```
    return a string that will set the width for a display webject for all cols of a group to the max num of chars contained in each col.
    NOTE: as a sideeffect it checks and makes sure first element(=line) has all attributes occurring in elements 2..n, so display-table will work properly
    
    Parameters:
    in - group to determine the widths for
    
    Returns:
    String e.g., 10,30,23,24
  - dumpGroup
```
public static void dumpGroup(Group wt_group)
```
    class to call dump of first element of group passed in. passes call to dumpGroup(group, 1)
    
    Parameters:
    wt_group - group to ask dump for
  - dumpGroup
```
public static void dumpGroup(Group g,
             int many)
```
    class to dump a number of elements of group passed in.
    
    Parameters:
    g - input group to dump
    many - number of elements to dump
  - fixObid
```
public static Group fixObid(Group in)
                     throws Exception
```
    make obid atts in group contain only the short obid for wt so we loop and change all values of atts named obid or masterReference
    
    Parameters:
    in - group to make subst in
    
    Returns:
    void
    
    Throws:
    
    Exception
  - fixObid
```
public static Group fixObid(Group in,
            String[] fixNames,
            boolean complain)
                     throws Exception
```
    make obid atts in group contain only the short obid for wt so we loop and change all values of atts in String[] fixNames
    
    Parameters:
    in - group to make subst in
    fixNames - names of atts to fix.
    
    Returns:
    void
    
    Throws:
    
    Exception
  - subGroup
```
public static Group subGroup(Group g,
             int skip,
             int n)
```
    return part of a group (for paging? )
    
    Parameters:
    g - group with all records
    skip - elements to skip
    n - number of elements to return
    
    Returns:
    Group newly created smaller group
  - shortObid
```
public static String shortObid(String longObid)
                        throws WTException
```
    Deprecated. Method shortObid(String) is deprecated, replaced by shortObid(Object).
    
    Throws:
    
    WTException
  - shortObid
```
public static String shortObid(String longObid,
               boolean throwException)
                        throws WTException
```
    Deprecated. Method shortObid(String ,boolean) is deprecated, replaced by shortObid(Object, boolean).
    
    Throws:
    
    WTException
  - shortObid
```
public static String shortObid(Object longObid)
                        throws WTException
```
    extract the short ([OV]R:class.name:seqnr) obid from a ufid
    
    Parameters:
    longObid -
    
    Returns:
    String
    
    Throws:
    
    Exception
    
    WTException
  - shortObid
```
public static String shortObid(Object longObid,
               boolean throwException)
                        throws WTException
```
    extract the short ([OV]R:class.name:seqnr) obid from a ufid
    
    Parameters:
    longObid -
    throwException -
    
    Returns:
    String
    
    Throws:
    
    Exception
    
    WTException
  - group2csv
```
public static String group2csv(Group in,
               String fdelim,
               String rdelim,
               boolean includeHeaders)
```
    make csv data from group
    
    Parameters:
    in - group to make data from
    
    Returns:
    data
  - hash2Group
```
public static Group hash2Group(Hashtable h,
               String groupName)
```
    Make an infoengine group from a hash table. Creates one row.
    
    Parameters:
    h - input hash table with name/value pairs
    groupName - name to give to newly created group
    
    Returns:
    Constructed group
  - hash2Group
```
public static Group hash2Group(Map h,
               String groupName)
```
    Make an infoengine group from a hash table. Creates one row.
    
    Parameters:
    h - input hash table with name/value pairs
    groupName - name to give to newly created group
    
    Returns:
    Constructed group
  - hash2Group
```
public static Group hash2Group(Hashtable h,
               String groupName,
               String key,
               String value)
```
    Make an infoengine group from a hash table, each key/value pair givng an element having a key and value att. Creates as many rows as necessary.
    
    Parameters:
    h - input hash table with key/value pairs
    groupName - name to give to newly created group
    key - Attribute name for the key column
    value - Attribute name for the value column
  - meta2att
```
public static void meta2att(Group in,
            String meta,
            String attName)
```
    adds normal Att for requested meta data
    
    Parameters:
    in -
    meta -
    attName -
  - removeAttNameTypePrefix
```
public static void removeAttNameTypePrefix(Group in,
                           String[] names)
                                    throws WTException
```
    removes the type prefix in an att's name (e.g., wt.part.WTPartUsageLink.quantity.unit -> quantity.unit)
    
    Parameters:
    in -
    
    Throws:
    
    Exception - if an att creates a duplicate name.
    
    WTException
  - removeAttNameTypePrefix
```
public static void removeAttNameTypePrefix(Group in,
                           String[] names,
                           String tail)
                                    throws WTException
```
    removes the type prefix in an att's name (e.g., wt.part.WTPartUsageLink.quantity.unit -> quantity.unit)
    
    Parameters:
    in -
    
    Throws:
    
    Exception - if an att creates a duplicate name.
    
    WTException
  - callTask
```
public static Group callTask(Persistable pbo,
             String myTaskName)
                      throws Exception
```
    workflow form of callTask
    
    Parameters:
    pbo - obid of the workflows primaryBusinessObject
    myTaskName - name of the Task
    
    Returns:
    the output group of the Task (or new Group with getSuccess()="ERROR" and exception-object and exception-message set if task.invoke() throws an exception e.g. task cannot be compiled)
    
    Throws:
    
    Exception - if the task setup fails.
  - callTask
```
public static Group callTask(Hashtable formHash,
             Group serverGroup,
             String myTaskName)
                      throws Exception
```
    short form of callTask
    
    Parameters:
    formHash - form data in a hash
    serverGroup - if null we'll create one - else server data to pass on
    myTaskName - name of the Task
    
    Returns:
    the output group of the Task (or new Group with getSuccess()="ERROR" and exception-object and exception-message set if task.invoke() throws an exception e.g. task cannot be compiled)
    
    Throws:
    
    Exception - if the task setup fails.
  - callTask
```
public static Group callTask(Hashtable formHash,
             Group serverGroup,
             String myTaskName,
             Hashtable params)
                      throws Exception
```
    Prepare and invoke an InfoEngine Task.
    
    Parameters:
    formHash - form data in a hash
    serverGroup - if null we'll create one - else server data to pass on
    myTaskName - name of the Task
    params - hashtable to make form param=name=value entries
    
    Returns:
    the output group of the Task (or new Group with getSuccess()="ERROR" and exception-object and exception-message set if task.invoke() throws an exception e.g. task cannot be compiled)
    
    Throws:
    
    Exception - if the task setup fails.
  - callTask
```
public static Hashtable callTask(Hashtable formHash,
                 Group serverGroup,
                 String myTaskName,
                 Hashtable params,
                 Boolean onlyDefault)
                          throws Exception
```
    Prepare and invoke an InfoEngine Task.
    
    Parameters:
    formHash - form data in a hash
    serverGroup - if null we'll create one - else server data to pass on
    myTaskName - name of the Task
    params - hashtable to make form param=name=value entries
    onlyDefault - flag if we want all group_outs
    
    Returns:
    a Hashtable with the output groups of the Task (or "error" Group with getSuccess()="ERROR" and exception-object and exception-message set if task.invoke() throws an exception e.g. task cannot be compiled) if flag = false or one entry "default" if flag is true
    
    Throws:
    
    Exception - if the task setup fails.
  - nn
```
public static String nn(Object o)
```
    returns an empty string if passed null or an object's string representation
    
    Parameters:
    o -
    
    Returns:
    String
  - nno
```
public static Object nno(Object o)
```
    returns an empty string if passed null or the object
    
    Parameters:
    o -
    
    Returns:
    Object
  - nn
```
public static String nn(Object o,
        String def)
```
    returns a default string if passed null or an object's string representation
    
    Parameters:
    o - obj. to test
    def - the default value
    
    Returns:
    String
  - nn
```
public static String nn(Object o,
        Object... da)
```
    returns a default string from varargs array (uses first non-null value) if passed null or an object's string representation
    
    Parameters:
    o - obj. to test
    da - array with potential default values, "" if empty or no non-null slot found.
    
    Returns:
    String
  - update
```
public static void update(WTCollection w)
                   throws Exception
```
    calls server side update method on a given Persistable, bypassing checkin/checkout etc.
    
    Parameters:
    p -
    
    Throws:
    
    Exception
  - update
```
public static void update(Persistable p)
                   throws Exception
```
    Throws:
    
    Exception
  - _update
```
public static void _update(WTCollection w)
                    throws Exception
```
    server side part of update method.
    
    Parameters:
    p -
    
    Throws:
    
    Exception
  - _update
```
public static void _update(Persistable p)
                    throws Exception
```
    Throws:
    
    Exception
  - trimAtt
```
public static void trimAtt(Group in,
           String attName)
```
    walks a group's elements and trims whitespace from a given Att's value - IeDatum will be String afterwards.
    
    Parameters:
    in -
    attName -
  - fixEscapes
```
public static void fixEscapes(String[] a)
```
    call fixEscapes for all strings in an array.
    
    Parameters:
    a - array with strings passed in.
  - fixEscapes
```
public static void fixEscapes(String a,
              StringBuffer b)
```
    replaces all occurrences of %hh (hh being two hex digits) with the character represented by hex value VR%3Awt.doc.WTDocument%3A423428 -> VR:wt.doc.WTDocument:423428
    currently provides no way to escape the % except with %25
    
    Parameters:
    a - String to make replacements to
    b - StringBuffer for new data, gets truncated first.
  - fixEscapes
```
public static String fixEscapes(String a)
```
    return string with occurences of %hh (hh being two hex digits) replaced with the character represented by hex value. if used more than once consider using the method that gets a StringBuffer passed for the newly created String.
    
    Parameters:
    a -
    
    Returns:
    String
  - group2HashArray
```
public static Map<String,Object>[] group2HashArray(Group in)
```
    return a group as an array of Hashtables filled with first att values, including com.infoengine.object.type meta (e.g., wt.part.WTPart)
    
    Parameters:
    in - group to unload
    
    Returns:
    Hashtable[]
  - element2Hash
```
public static Map<String,Object> element2Hash(Element in)
```
    make a hashtable from an Element
    
    Parameters:
    in - Element to act upon
    
    Returns:
    Hashtable
  - group2HashArray
```
public static Map<String,Object>[] group2HashArray(Group in,
                                   boolean toLower)
```
    return a group as an array of Hashtables filled with first att values, including com.infoengine.object.type meta (e.g., wt.part.WTPart)
    
    Parameters:
    in - group to unload
    toLower - flag whether to lowercase att names
    
    Returns:
    Hashtable[]
  - lookupFromGroup
```
public static Hashtable lookupFromGroup(Group in,
                        String key,
                        String value)
```
    return a lookup hash made from two cols of a group
    
    Parameters:
    in - group to unload
    
    Returns:
    Hashtable
  - saveGroup
```
public static void saveGroup(Group g,
             String s)
                      throws Exception
```
    serialize an infoengine group to a file.
    
    Parameters:
    g - the group
    s - the filename
    
    Throws:
    
    Exception
  - readGroup
```
public static Group readGroup(String s)
                       throws Exception
```
    deserialize an infoengine group from a file.
    
    Parameters:
    s - the filename
    
    Returns:
    Group
    
    Throws:
    
    Exception
  - prettyPrint
```
public static String prettyPrint(byte b)
```
  - prettyPrint
```
public static String prettyPrint(boolean b)
```
  - prettyPrint
```
public static String prettyPrint(int b)
```
  - prettyPrint
```
public static String prettyPrint(short b)
```
  - prettyPrint
```
public static String prettyPrint(long b)
```
  - prettyPrint
```
public static String prettyPrint(float b)
```
  - prettyPrint
```
public static String prettyPrint(double b)
```
  - prettyPrint
```
public static String prettyPrint(Object o)
```
    simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output.
    
    Parameters:
    o -
    
    Throws:
    
    @return - String
  - prettyPrint
```
public static String prettyPrint(Object o,
                 boolean wantNL)
```
    simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output. on demand replace \n with ' '
    
    Parameters:
    o -
    wantNL -
    
    Throws:
    
    @return - String
  - prettyPrint
```
public static String prettyPrint(Object o,
                 boolean wantNL,
                 boolean includeMeta)
```
    simple override method for fullblown prettyPrint - returns a string of the obj's prettyprinted representation result will (intentionally) resemble perl's Data::Dumper output. on demand replace \n with ' '
    
    Parameters:
    o -
    wantNL -
    
    Throws:
    
    @return - String
  - prettyPrint
```
public static String prettyPrint(Object o,
                 StringBuffer b,
                 String indent,
                 boolean wantNL)
```
    print an object in a layout that allows to identify hases, vectors etc. including contents.
    Collection gives ( data data data ...)
    Map gives { key => value, key => value ... }
    enumeration will print it's elements
    arrays prints [ elem elem ...]
    wtobjects print displayidentifier
    IEobjects are printed with toXML (including meta info) else we print obj.toString() (classname)
    
    Parameters:
    o - the object
    b - a stringbuffer to fill
    indent - indentation to use for prettyprintend output
    wantNL - flag if lines are ended with \n or space
    
    Throws:
    
    @return - String
  - prettyPrint
```
public static String prettyPrint(Object o,
                 StringBuffer b,
                 String indent,
                 boolean wantNL,
                 boolean includeMeta)
```
    print an object in a layout that allows to identify hases, vectors etc. including contents.
    Collection gives ( data data data ...)
    Map gives { key => value, key => value ... }
    enumeration will print it's elements
    arrays prints [ elem elem ...]
    wtobjects print displayidentifier
    else we print obj.toString() (classname)
    
    Parameters:
    o - the object
    b - a stringbuffer to fill
    indent - indentation to use for prettyprintend output
    wantNL - flag if lines are ended with \n or space
    includeMeta - flag if IEobjects.toXML should containe meta infos
    
    Throws:
    
    @return - String
  - hash2ParamGroup
```
public static Group hash2ParamGroup(Hashtable h,
                    Hashtable f,
                    String groupName)
```
    prepare a form group from 2 hashes, one gives "normal" atts, the other makes atts of the form param=name=value
    
    Parameters:
    h -
    f -
    groupName -
    
    Returns:
    Group
  - logGroup
```
public static void logGroup(Logger l,
            Group g,
            String reason)
```
    log a group's xml to the log4j logger.
    
    Parameters:
    l - the logger
    g - the group
    reason - string to print in line before groups's xml appears
    
    Throws:
    
    @return - void
  - logGroup
```
public static void logGroup(Logger l,
            Group g)
```
    log a group's xml to the log4j logger.
    
    Parameters:
    l - the logger
    g - the group
    
    Throws:
    
    @return - void
  - logElement
```
public static void logElement(Logger l,
              Element e)
```
    log a group's xml to the log4j logger.
    
    Parameters:
    l - the logger
    g - the group
    
    Throws:
    
    @return - void
  - mergeSelectedAtts
```
public static void mergeSelectedAtts(Group in,
                     String key,
                     Group from,
                     String look,
                     String[] use)
                              throws IEException
```
    merge the atts from one group into the rows of a receiving group, using a value from the receiving group as key into group from will throw exception if the lookup key value is not present in "from" group.
    
    Parameters:
    in - receiving group
    key - col name of key into group from
    from - group to merge in
    look - colname for key lookup
    use - array of column names to merge into new group. possibly existing atts are first removed.
    
    Throws:
    
    IEException - thrown for various error conditions
  - isValUnique
```
public static boolean isValUnique(Group g,
                  String col)
```
    tell if a group's column contains the same value in all rows (e.g. verify all rows have the same value for att number)
    
    Parameters:
    g - the group
    col - the column name
    
    Throws:
    
    @return - boolean
  - formatFloatToInt
```
public static void formatFloatToInt(Group g,
                    String[] cols)
```
    try to reformat the value[s] into integers
    
    Parameters:
    g - the group @param col array with col names @exception
  - isRoleMaster
```
public static boolean isRoleMaster(String link,
                   int roleoff)
                            throws WTException
```
    tell caller if a links roleA or roleB object is a Master. according to windchill's design pattern we use introspection to find a links two-argument static constructor method, which happens to be called new<LinkName> e.g., newWTPartUsageLink the first such method is inspected and queried for the object types of it's parameters. the result is cached so we speed up things. as of now all of the links we needed could be inspected that way. in case it happens that a link misses the appropriate constructor, the linkroles hash should be initialized to contain the data for such links.
    
    Parameters:
    link - string name of link class, e.g., wt.part.WTPartUsageLink
    roleoff - 0=roleA, 1=roleB
    
    Returns:
    boolean
    
    Throws:
    
    WTException
  - unescapeXML
```
public static String unescapeXML(Object o)
```
    escape xml (or html) special chars & > < " ' with their textual representation e.g. &->&
    
    Parameters:
    o - the object to print (o.toString() or "" if null)
    
    Returns:
    String the escaped string
  - escapeXML
```
public static String escapeXML(Object o)
```
    escape xml (or html) special chars & > < " ' with their textual representation e.g. &->&
    
    Parameters:
    o - the object to print (o.toString() or "" if null)
    
    Returns:
    String the escaped string
  - objFromObid
```
public static Persistable objFromObid(Object obid)
                               throws WTException
```
    return a persistable from an object (which via toString() must give an obid)
    
    Parameters:
    obid -
    
    Returns:
    Persistable
    
    Throws:
    
    WTException
  - wrkObjFromObid
```
public static Workable wrkObjFromObid(Object obid)
                               throws WTException
```
    return a persistable from an object (which via toString() must give an obid), return the working copy if the object is checked out.
    
    Parameters:
    obid -
    
    Returns:
    Persistable
    
    Throws:
    
    WTException
  - latestVersionWrkObjFromObid
```
public static Workable latestVersionWrkObjFromObid(Object obid)
                                            throws WTException
```
    return the latest version of a persistable from an object (which via toString() must give an obid), return the working copy if the object is checked out.
    
    Parameters:
    obid -
    
    Returns:
    Persistable
    
    Throws:
    
    WTException
  - deser
```
public static void deser(String[] argv)
                  throws Exception
```
    deserialize an object from a file and dump it to stdout
    
    Parameters:
    argv -
    
    Throws:
    
    Exception
  - deserLA
```
public static void deserLA(String[] argv)
                    throws Exception
```
    deserialize an object from a file and dump it to stdout
    
    Parameters:
    argv -
    
    Throws:
    
    Exception
  - deserex
```
public static void deserex(String[] argv)
                    throws Exception
```
    deserialize the base64 encoded text given in argv into an object and either print a stacktrace (if it's an exception) or dump it to stdout typical use to get a stacktrace for the exception message in an I*E error group
    
    Parameters:
    argv -
    
    Throws:
    
    Exception
  - logException
```
public static void logException(Logger l,
                Throwable e)
```
    log an exceptions stacktrace to the logger
    
    Parameters:
    l -
    e -
    
    Throws:
    
    Exception
  - getVR
```
public static String getVR(Iterated p)
```
    return an iterated's VR: obid
    
    Parameters:
    p - the persistable
    
    Throws:
    
    @return - String
  - getOR
```
public static String getOR(Persistable p)
```
    return a Persistable's OR: obid
    
    Parameters:
    p - the persistable
    
    Throws:
    
    @return - String
  - getOR
```
public static String getOR(Object p)
```
    return an obid for the object, of the obj is a Persistable and persisted gives normal OR:class:ida2a2 obid. otherwise tries to make something useful ;-)
    
    Parameters:
    p -
    
    Throws:
    
    @return - String
  - rmDashR
```
public static boolean rmDashR(String fOrD)
```
    recursively delete file or directory
    
    Parameters:
    fOrD - the file or dir to remove
    
    Throws:
    
    @return - boolean
  - rmDashR
```
public static boolean rmDashR(File fOrD)
```
    recursively delete file or directory
    
    Parameters:
    fOrD - the file or dir to remove
    
    Throws:
    
    @return - boolean
  - delete
```
public static void delete(String[] as)
                   throws Exception
```
    brute force remove obj with server side method. bypasses listeners.
    
    Parameters:
    as - [] string array with obid of objs to delete.
    
    Throws:
    
    Exception
  - _delete
```
public static void _delete(String[] as)
                    throws Exception
```
    server side part of delete()
    
    Parameters:
    as - [] string array with obid of objs to delete.
    
    Throws:
    
    Exception
  - extractMessage
```
public static String extractMessage(Group g)
```
    extract from a (typically @SERVER) group the innermost exception-message
    
    Parameters:
    g -
    
    Throws:
    
    @return - String the message.
  - extractMessage
```
public static String extractMessage(Group g,
                    Logger logger1)
```
    extract from a (typically @SERVER) group the innermost exception-message
    
    Parameters:
    g -
    
    Throws:
    
    @return - String the message.
  - innerMessage
```
public static String innerMessage(Throwable e)
```
    return the message of an exception, if nested exceptions exist return the innermost message.
    
    Parameters:
    e -
    
    Throws:
    
    @return - String
  - s2o
```
public static Object s2o(String s)
                  throws Exception
```
    deserialize an object from a base64 string
    
    Parameters:
    s - the base64 string
    
    Returns:
    void
    
    Throws:
    
    Exception
  - o2s
```
public static String o2s(Object o)
                  throws Exception
```
    serialize an object into a base64 string
    
    Parameters:
    o - the obj to serialize
    
    Returns:
    String
    
    Throws:
    
    Exception
  - o2f
```
public static void o2f(Object o,
       String s)
                throws Exception
```
    serialize an object to a file.
    
    Parameters:
    o - the object
    f - the filename
    
    Throws:
    
    Exception
  - f2o
```
public static Object f2o(String f)
                  throws Exception
```
    deserialize an object from a file.
    
    Parameters:
    f - the filename
    
    Returns:
    Group
    
    Throws:
    
    Exception
  - getRevString
```
public static String getRevString(Persistable perObj)
```
  - objectInfo
```
public static String objectInfo(Persistable obj)
```
  - nnx
```
public static String nnx(Object s)
```
    return nn with html escapes
    
    Parameters:
    object - to stringify
    
    Throws:
    
    @return - String
  - nnx
```
public static String nnx(Object s,
         String d)
```
    return nn with html escapes
    
    Parameters:
    s - object to stringify
    d - default if o null
    
    Throws:
    
    @return - String
  - getWTUserByName
```
public static WTUser getWTUserByName(String username)
                              throws Exception
```
    Throws:
    
    Exception
  - getWTUserByName
```
public static WTUser getWTUserByName(String username,
                     boolean ignorecase)
                              throws Exception
```
    Throws:
    
    Exception
  - getWTUserByName
```
public static WTUser getWTUserByName(String username,
                     boolean ignorecase,
                     boolean throwException)
                              throws Exception
```
    Throws:
    
    Exception
  - getWTUserByName
```
public static WTUser getWTUserByName(String username,
                     boolean ignorecase,
                     boolean useLike,
                     boolean throwException)
                              throws Exception
```
    get a wtuser obj by username. search field is "name"
    
    Parameters:
    username -
    ignorecase -
    throwException - : if true throw exception if user is not found.
    
    Returns:
    
    Throws:
    
    Exception
  - getWTObjectByNumber
```
public static Persistable getWTObjectByNumber(String objNumber,
                              boolean getMaster)
                                       throws WTException,
                                              RemoteException,
                                              InvocationTargetException
```
    Throws:
    
    WTException
    
    RemoteException
    
    InvocationTargetException
  - jmxConn
```
public static String jmxConn()
                      throws Exception
```
    Throws:
    
    Exception
  - ne
```
public static String ne(Object o,
        Object... da)
```
  - getStackTrace
```
public static String getStackTrace(Throwable aThrowable)
```
  - isAlphaNumeric
```
public static boolean isAlphaNumeric(String text)
```
  - getWTObject
```
public static Persistable getWTObject(Object o)
                               throws Exception
```
    Throws:
    
    Exception

Class ToolUtils

Field Summary

Fields inherited from interface RemoteAccess

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

MAJOR

MINOR

RMIHOSTNAME

HTTPGWHOSTNAME

WEBAPPNAME

WTHOME

SERVER

NONALPHANUM

Constructor Detail

ToolUtils

Method Detail

main

getVersion

getIntVersion

isRequiredVersion

dbConnect

setStates

setLC

rotGroup

getWidths

dumpGroup

dumpGroup

fixObid

fixObid

subGroup

shortObid

shortObid

shortObid

shortObid

group2csv

hash2Group

hash2Group

hash2Group

meta2att

removeAttNameTypePrefix

removeAttNameTypePrefix

callTask

callTask

callTask

callTask

nn

nno

nn

nn

update

update

_update

_update

trimAtt

fixEscapes

fixEscapes

fixEscapes

group2HashArray

element2Hash

group2HashArray

lookupFromGroup

saveGroup

readGroup

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

prettyPrint

hash2ParamGroup

logGroup

logGroup