ViewableMagicHelper

Object
- ViewableMagicHelper

All Implemented Interfaces:

RemoteAccess
```
public class ViewableMagicHelper
extends Object
implements RemoteAccess
```
purpose: web & cmd line based tool/api for mass-handling of viewables

Author:

pnierkamp@sulis.de 20121114 pn; added new search abilities v2.4 20121114 pn; changed search behaviour. fixed sqllike search... enhanced jsp. need querymagic v2.8!! v2.5 20140206 pb; removed unused static finals and the DBTYPE block. MinorVersion increased. v2.6 20140312 pb; added excelsheet output of searchresults. MinorVersion increased. v2.7 20142403 pb; added csv export and excelexport valid check. User decides in vm-jsp if export of search matches is made (csv and/or excel). v2.8 20142703 pb&pn; reviewed and changed excelexport functionality. Now separate methods: 'doExcelExport' and 'doCSVExport' do each the export and are called by 'query' v2.9 20141106 pb; refactoring to move the export,work,config folders from codebase/ext/sulis/viewablemagic to a property defined viewablemagic-folder. Property set in wt.properties is "wt.publish.viewablemagic.configdir","wt.publish.viewablemagic.exportdir","wt.publish.viewablemagic.workdir" v2.9 20140709 pb; changed EXPORTBASE,CONFIGBASE,EXPORTBASE definition to ext.sulis.viewablemagic.* for wt.properties entry and used ToolUtils.nn for initialization v2.10 20141124 pn; optimized query for rep searc v2.11 20150826 pn; bugfixing folder filtered search

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIGBASE`
`static String`	`CONFIGFILENAME`
`static String`	`CREATEREP`
`static String`	`DATAKEY_QUERY`
`static String`	`DATAKEY_RESULT`
`static String`	`DATAKEY_WORK`
`static String`	`DELREP`
`static String`	`DISPLAYFILTER`
`static String`	`EXPORTBASE`
`static boolean[]`	`EXPORTERROR` boolean array for export error handling.<
`static String`	`FILTER`
`static String`	`FILTER_AFTER`
`static String`	`FILTER_AFTER_DATE`
`static String`	`FILTER_ALL`
`static String`	`FILTER_BEFORE`
`static String`	`FILTER_BEFORE_DATE`
`static String`	`FILTER_CUSTOM_METHOD`
`static String`	`FILTER_CUSTOM_METHOD_RADIO`
`static String`	`FILTER_MISSING`
`static String`	`FILTER_NOTHUMB`
`static String`	`HTTPGWHOSTNAME`
`static String`	`INFO`
`static String`	`LOGFILENAME`
`static String`	`MAINJSP`
`static int`	`MAJOR` MAJOR version of the SulisViewableMagic as integer
`static int`	`MINOR` MINOR version of the SulisViewableMagic as integer
`static String`	`OBJ`
`static String`	`OID`
`static String`	`PAGECUR`
`static String`	`PAGERESULTS`
`static String`	`PAGESIZE`
`static String`	`REPDATE`
`static String`	`REPSTATE`
`static String`	`RESULTFILENAME`
`static String`	`RMIHOSTNAME`
`static boolean`	`SERVER`
`static String`	`SHOWRESULT`
`static String`	`STATE`
`static String`	`UNDOJSP`
`static String`	`UPLOADJSP`
`static String`	`WEBAPPNAME`
`static String`	`WORKBASE`
`static String`	`WORKFILENAME`
`static String[]`	`WORKLISTKEYS`
`static String`	`WORKSPACENAME`
`static String`	`WTHOME`

Fields inherited from interface RemoteAccess
versionID

Constructor Summary

Constructors
Constructor and Description

ViewableMagicHelper()

Constructors
Constructor and Description
`ViewableMagicHelper()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`askUserYesNo(String questionTxt)`
`static boolean`	`checkAccess()` method to check if user has access e.g.
`static void`	`cmdDelNotLatestRep(HashMap<String,String> params)`
`static void`	`deleteRepresentations(Representable rep)` deletes the representations of an Representable Object
`static void`	`delNotLatestRep(HashMap<String,String> params)`
`static HashMap<String,String>`	`getDefaultParams()` method to return default parameters within a Hashmap with following keys WORKSPACENAME,RESULTFILENAME,LOGFILENAME,WORKFILENAME,CONFIGFILENAME,DELREP, CREATEREP,LOGFILENAME,WORKFILENAME,WORKFILENAME,PAGERESULTS,PAGESIZE,PAGECUR, FILTER,QueryMagic.FOLDERSM,QueryMagic.REVISIONSM,QueryMagic.NUMBERSM,QueryMagic.NAMESM, QueryMagic.CADNAMESM,QueryMagic.LCSSTATESM,QueryMagic.CREATORSM,QueryMagic.CREATORSM, QueryMagic.MODIFIERSM,QueryMagic.IBANAMESM,QueryMagic.IBAVALUESM,QueryMagic.IBAVALUESM, QueryMagic.IBANAMESM2,QueryMagic.IBAVALUESM2,DISPLAYFILTER
`static List`	`getLinkedApplicationData(Persistable per)`
`static HashMap<String,String>`	`loadConfig(File configFile)` Method loads a Configfile for prestored configurations of ViewableMagic.
`static void`	`main(String[] args)`
`static void`	`printUsage()` prints the usage of ViewableMagic to the console.
`static void`	`processWorkList(File workfile, HashMap<String,String> queryParams)` Method processes a given worklist by a certain workfile and a HashMap of queryParams.
`static Vector<String>`	`query(HashMap<String,String> queryParams)` Method for the search query.
`static Vector<String>`	`queryJSP(HashMap<String,String> queryParams)`
`static void`	`saveConfig(File configFile, HashMap<String,String> queryParams)` Method saves a configuration of the entered search parameters to file.

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

- Field Detail
  - MAJOR
```
public static final int MAJOR
```
    MAJOR version of the SulisViewableMagic as integer
    
    See Also:
    Constant Field Values
  - MINOR
```
public static final int MINOR
```
    MINOR version of the SulisViewableMagic as integer
    
    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
```
  - DATAKEY_QUERY
```
public static final String DATAKEY_QUERY
```
    See Also:
    Constant Field Values
  - DATAKEY_WORK
```
public static final String DATAKEY_WORK
```
    See Also:
    Constant Field Values
  - DATAKEY_RESULT
```
public static final String DATAKEY_RESULT
```
    See Also:
    Constant Field Values
  - WORKSPACENAME
```
public static final String WORKSPACENAME
```
    See Also:
    Constant Field Values
  - RESULTFILENAME
```
public static final String RESULTFILENAME
```
    See Also:
    Constant Field Values
  - LOGFILENAME
```
public static final String LOGFILENAME
```
    See Also:
    Constant Field Values
  - WORKFILENAME
```
public static final String WORKFILENAME
```
    See Also:
    Constant Field Values
  - CONFIGFILENAME
```
public static final String CONFIGFILENAME
```
    See Also:
    Constant Field Values
  - FILTER
```
public static final String FILTER
```
    See Also:
    Constant Field Values
  - FILTER_ALL
```
public static final String FILTER_ALL
```
    See Also:
    Constant Field Values
  - FILTER_MISSING
```
public static final String FILTER_MISSING
```
    See Also:
    Constant Field Values
  - FILTER_NOTHUMB
```
public static final String FILTER_NOTHUMB
```
    See Also:
    Constant Field Values
  - FILTER_BEFORE
```
public static final String FILTER_BEFORE
```
    See Also:
    Constant Field Values
  - FILTER_AFTER
```
public static final String FILTER_AFTER
```
    See Also:
    Constant Field Values
  - FILTER_BEFORE_DATE
```
public static final String FILTER_BEFORE_DATE
```
    See Also:
    Constant Field Values
  - FILTER_AFTER_DATE
```
public static final String FILTER_AFTER_DATE
```
    See Also:
    Constant Field Values
  - FILTER_CUSTOM_METHOD_RADIO
```
public static final String FILTER_CUSTOM_METHOD_RADIO
```
    See Also:
    Constant Field Values
  - FILTER_CUSTOM_METHOD
```
public static final String FILTER_CUSTOM_METHOD
```
    See Also:
    Constant Field Values
  - DELREP
```
public static final String DELREP
```
    See Also:
    Constant Field Values
  - CREATEREP
```
public static final String CREATEREP
```
    See Also:
    Constant Field Values
  - SHOWRESULT
```
public static final String SHOWRESULT
```
    See Also:
    Constant Field Values
  - PAGERESULTS
```
public static final String PAGERESULTS
```
    See Also:
    Constant Field Values
  - PAGESIZE
```
public static final String PAGESIZE
```
    See Also:
    Constant Field Values
  - PAGECUR
```
public static final String PAGECUR
```
    See Also:
    Constant Field Values
  - DISPLAYFILTER
```
public static final String DISPLAYFILTER
```
    See Also:
    Constant Field Values
  - OID
```
public static final String OID
```
    See Also:
    Constant Field Values
  - OBJ
```
public static final String OBJ
```
    See Also:
    Constant Field Values
  - STATE
```
public static final String STATE
```
    See Also:
    Constant Field Values
  - INFO
```
public static final String INFO
```
    See Also:
    Constant Field Values
  - REPSTATE
```
public static final String REPSTATE
```
    See Also:
    Constant Field Values
  - REPDATE
```
public static final String REPDATE
```
    See Also:
    Constant Field Values
  - WORKLISTKEYS
```
public static final String[] WORKLISTKEYS
```
  - WORKBASE
```
public static final String WORKBASE
```
  - CONFIGBASE
```
public static final String CONFIGBASE
```
  - EXPORTBASE
```
public static final String EXPORTBASE
```
  - UPLOADJSP
```
public static final String UPLOADJSP
```
  - UNDOJSP
```
public static final String UNDOJSP
```
  - MAINJSP
```
public static final String MAINJSP
```
  - EXPORTERROR
```
public static boolean[] EXPORTERROR
```
    boolean array for export error handling.< br/> EXPORTERROR[0]=true if excelexport fails due to an error
    EXPORTERROR[1]=true if csvexport fails due to an error
    false else
- Constructor Detail
  - ViewableMagicHelper
```
public ViewableMagicHelper()
```
- Method Detail
  - getDefaultParams
```
public static HashMap<String,String> getDefaultParams()
```
    method to return default parameters within a Hashmap with following keys
    WORKSPACENAME,RESULTFILENAME,LOGFILENAME,WORKFILENAME,CONFIGFILENAME,DELREP, CREATEREP,LOGFILENAME,WORKFILENAME,WORKFILENAME,PAGERESULTS,PAGESIZE,PAGECUR, FILTER,QueryMagic.FOLDERSM,QueryMagic.REVISIONSM,QueryMagic.NUMBERSM,QueryMagic.NAMESM, QueryMagic.CADNAMESM,QueryMagic.LCSSTATESM,QueryMagic.CREATORSM,QueryMagic.CREATORSM, QueryMagic.MODIFIERSM,QueryMagic.IBANAMESM,QueryMagic.IBAVALUESM,QueryMagic.IBAVALUESM, QueryMagic.IBANAMESM2,QueryMagic.IBAVALUESM2,DISPLAYFILTER
    
    Returns:
    HashMap
  - checkAccess
```
public static boolean checkAccess()
                           throws WTException
```
    method to check if user has access e.g. is administrative user.< br/> Returns if allowed boolean true.
    
    Returns:
    boolean
    
    Throws:
    
    WTException
  - query
```
public static Vector<String> query(HashMap<String,String> queryParams)
                            throws Exception
```
    Method for the search query. requires the HasMap 'searchParams' with certain values from viewablemagic.jsp. < br/> Method creates a serialized file and an optional excelsheet and/or csv file with the search parameters and search results.
    The file is stored within /work.
    
    Parameters:
    queryParams -
    
    Returns:
    
    Throws:
    
    Exception
  - queryJSP
```
public static Vector<String> queryJSP(HashMap<String,String> queryParams)
                               throws Exception
```
    Throws:
    
    Exception
  - processWorkList
```
public static void processWorkList(File workfile,
                   HashMap<String,String> queryParams)
                            throws Exception
```
    Method processes a given worklist by a certain workfile and a HashMap of queryParams.
    
    Parameters:
    workfile -
    queryParams -
    
    Throws:
    
    Exception
  - loadConfig
```
public static HashMap<String,String> loadConfig(File configFile)
                                         throws Exception
```
    Method loads a Configfile for prestored configurations of ViewableMagic.
    
    Parameters:
    configFile -
    
    Returns:
    
    Throws:
    
    Exception
  - saveConfig
```
public static void saveConfig(File configFile,
              HashMap<String,String> queryParams)
                       throws Exception
```
    Method saves a configuration of the entered search parameters to file.
    
    Parameters:
    configFile -
    queryParams -
    
    Throws:
    
    Exception
  - deleteRepresentations
```
public static void deleteRepresentations(Representable rep)
```
    deletes the representations of an Representable Object
    
    Parameters:
    rep -
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception
  - printUsage
```
public static void printUsage()
```
    prints the usage of ViewableMagic to the console.
  - askUserYesNo
```
public static boolean askUserYesNo(String questionTxt)
```
  - cmdDelNotLatestRep
```
public static void cmdDelNotLatestRep(HashMap<String,String> params)
                               throws Exception
```
    Throws:
    
    Exception
  - delNotLatestRep
```
public static void delNotLatestRep(HashMap<String,String> params)
                            throws Exception
```
    Throws:
    
    Exception
  - getLinkedApplicationData
```
public static List getLinkedApplicationData(Persistable per)
```

Class ViewableMagicHelper

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

DATAKEY_QUERY

DATAKEY_WORK

DATAKEY_RESULT

WORKSPACENAME

RESULTFILENAME

LOGFILENAME

WORKFILENAME

CONFIGFILENAME

FILTER

FILTER_ALL

FILTER_MISSING

FILTER_NOTHUMB

FILTER_BEFORE

FILTER_AFTER

FILTER_BEFORE_DATE

FILTER_AFTER_DATE

FILTER_CUSTOM_METHOD_RADIO

FILTER_CUSTOM_METHOD

DELREP

CREATEREP

SHOWRESULT

PAGERESULTS

PAGESIZE

PAGECUR

DISPLAYFILTER

OID

OBJ

STATE

INFO

REPSTATE

REPDATE

WORKLISTKEYS

WORKBASE

CONFIGBASE

EXPORTBASE

UPLOADJSP

UNDOJSP

MAINJSP

EXPORTERROR

Constructor Detail

ViewableMagicHelper

Method Detail

getDefaultParams

checkAccess

query

queryJSP

processWorkList

loadConfig

saveConfig

deleteRepresentations

main

printUsage

askUserYesNo

cmdDelNotLatestRep

delNotLatestRep

getLinkedApplicationData