com.etasoft.trans.map
Class axMap

java.lang.Object
  extended bycom.etasoft.trans.map.axMap
All Implemented Interfaces:
axSerializable, java.io.Serializable

public class axMap
extends java.lang.Object
implements axSerializable

Map contains all Map Objects.

See Also:
Serialized Form

Nested Class Summary
 class axMap.axMapFindFast
          Map Find Fast implementation.
 
Constructor Summary
axMap()
           
axMap(axMap right, boolean bKeepId)
          Creates shadow copy of the map for processing.
 
Method Summary
 axMapObject addInto(axMapObject mapCurrObj, axMapObject mapOrigObj, boolean removeMappings)
           
 axMapObject addInto(axMapObject mapCurrObj, int nOffset, axMapObject mapOrigObj, boolean removeMappings)
           
 void addItem(axMapRoot root, boolean inputSide)
          Add root item to the map.
 void copy(axMapObject mapObj)
           
 void cut(axMapObject mapObj)
           
 axMapObject deepCopy(axMapObject mapObj, boolean copyMappings)
           
 void delete(axMapObject mapObj)
           
 java.lang.Boolean evalPlugin(axMapPluginBoolMethod method, java.lang.Integer id, java.lang.String data, java.lang.String parameters, axDocHandler docHandler)
          Call validation/condition plug-in.
 java.lang.String execPlugin(axMapPluginExecMethod method, java.lang.Integer id, java.lang.String data, java.lang.String parameters, axDocHandler docHandler)
          Call execution plug-in.
 axMapObject findById(int index)
          Find map object by its index.
 axMapObject findByNamePart(java.lang.String namePart)
          Find map object by part of its name.
 axMap.axMapFindFast findFast()
          Return axMapFindFast object for reuse.
 axMapObject findFastById()
          Find fast map object based on id, used in processing.
 axMapTransaction getInputTransaction()
           
 int getMapVersion()
          Version of the map format that was used to save the map.
 axMapTransaction getOutputTransaction()
           
 java.lang.String[] getPluginArray(int pluginType)
          Get plug-in list.
 axMapPluginOptions getPluginOptions()
           
static java.lang.String getRuntimeVersion()
          Get current runtime version.
 axMapScriptArray getScriptArray()
           
 boolean isCopyAvailable(axMapObject mapObj)
           
 java.util.Iterator iteratorLinear()
          Get new Linear iterator.
 java.util.Iterator iteratorLinear(axMapObject mapObj)
          Get new Linear iterator using some map object as a start.
 void loadAllPlugins()
          Load all plug-ins.
 boolean mapUnmap(axMapObject mapLeftObj, axMapObject mapRightObj)
           
 void pasteInto(axMapObject mapCurrObj, boolean removeMappings)
           
 void pasteInto(axMapObject mapCurrObj, int nOffset, boolean removeMappings)
           
 int performAutoMap(int charCount, boolean typeMatch, boolean useCase, boolean readOnly)
           
 void removeItem(axMapObject obj, boolean inputSide)
          Remove root item from the map.
 void removeItemAt(int index, boolean inputSide)
          Remove item based on index provided.
 void setCacheDirty(boolean cacheDirty)
          Mark Linear iterator cache as dirty.
 void setPluginOptions(axMapPluginOptions mapPluginOptions)
           
 void setReloadPlugins(boolean reloadPlugins)
          Flag plug-ins for reload.
 void setScriptArray(axMapScriptArray mapScriptArray)
           
 java.lang.Boolean transactPlugin(axMapPluginTransactMethod method, java.lang.Integer id, java.lang.String parameters)
          Call transaction control plug-in.
 void unloadAllPlugins()
          Unload all plug-ins.
 void write(java.io.ObjectOutputStream stream0)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

axMap

public axMap()

axMap

public axMap(axMap right,
             boolean bKeepId)
Creates shadow copy of the map for processing.

Method Detail

write

public void write(java.io.ObjectOutputStream stream0)
           throws java.io.IOException
Throws:
java.io.IOException

getRuntimeVersion

public static java.lang.String getRuntimeVersion()
Get current runtime version.


getMapVersion

public int getMapVersion()
Version of the map format that was used to save the map.


getInputTransaction

public axMapTransaction getInputTransaction()

getOutputTransaction

public axMapTransaction getOutputTransaction()

getPluginOptions

public axMapPluginOptions getPluginOptions()

setPluginOptions

public void setPluginOptions(axMapPluginOptions mapPluginOptions)

getScriptArray

public axMapScriptArray getScriptArray()

setScriptArray

public void setScriptArray(axMapScriptArray mapScriptArray)

setReloadPlugins

public void setReloadPlugins(boolean reloadPlugins)
Flag plug-ins for reload.


loadAllPlugins

public void loadAllPlugins()
                    throws java.lang.Exception
Load all plug-ins.

Throws:
java.lang.Exception

unloadAllPlugins

public void unloadAllPlugins()
Unload all plug-ins.


getPluginArray

public java.lang.String[] getPluginArray(int pluginType)
                                  throws java.lang.Exception
Get plug-in list.

Throws:
java.lang.Exception

execPlugin

public java.lang.String execPlugin(axMapPluginExecMethod method,
                                   java.lang.Integer id,
                                   java.lang.String data,
                                   java.lang.String parameters,
                                   axDocHandler docHandler)
                            throws axException
Call execution plug-in.

Throws:
axException

evalPlugin

public java.lang.Boolean evalPlugin(axMapPluginBoolMethod method,
                                    java.lang.Integer id,
                                    java.lang.String data,
                                    java.lang.String parameters,
                                    axDocHandler docHandler)
                             throws axException
Call validation/condition plug-in.

Throws:
axException

transactPlugin

public java.lang.Boolean transactPlugin(axMapPluginTransactMethod method,
                                        java.lang.Integer id,
                                        java.lang.String parameters)
                                 throws axException
Call transaction control plug-in.

Throws:
axException

addItem

public void addItem(axMapRoot root,
                    boolean inputSide)
             throws axException
Add root item to the map.

Throws:
axException

removeItem

public void removeItem(axMapObject obj,
                       boolean inputSide)
Remove root item from the map.


removeItemAt

public void removeItemAt(int index,
                         boolean inputSide)
Remove item based on index provided.


setCacheDirty

public void setCacheDirty(boolean cacheDirty)
Mark Linear iterator cache as dirty.


iteratorLinear

public java.util.Iterator iteratorLinear()
Get new Linear iterator.


iteratorLinear

public java.util.Iterator iteratorLinear(axMapObject mapObj)
Get new Linear iterator using some map object as a start.


findById

public axMapObject findById(int index)
Find map object by its index.


findByNamePart

public axMapObject findByNamePart(java.lang.String namePart)
Find map object by part of its name.


findFastById

public axMapObject findFastById()
Find fast map object based on id, used in processing.


findFast

public axMap.axMapFindFast findFast()
Return axMapFindFast object for reuse.


deepCopy

public axMapObject deepCopy(axMapObject mapObj,
                            boolean copyMappings)

addInto

public axMapObject addInto(axMapObject mapCurrObj,
                           axMapObject mapOrigObj,
                           boolean removeMappings)
                    throws axException
Throws:
axException

addInto

public axMapObject addInto(axMapObject mapCurrObj,
                           int nOffset,
                           axMapObject mapOrigObj,
                           boolean removeMappings)
                    throws axException
Throws:
axException

mapUnmap

public boolean mapUnmap(axMapObject mapLeftObj,
                        axMapObject mapRightObj)

cut

public void cut(axMapObject mapObj)

copy

public void copy(axMapObject mapObj)

pasteInto

public void pasteInto(axMapObject mapCurrObj,
                      boolean removeMappings)
               throws axException
Throws:
axException

pasteInto

public void pasteInto(axMapObject mapCurrObj,
                      int nOffset,
                      boolean removeMappings)
               throws axException
Throws:
axException

delete

public void delete(axMapObject mapObj)

isCopyAvailable

public boolean isCopyAvailable(axMapObject mapObj)

performAutoMap

public int performAutoMap(int charCount,
                          boolean typeMatch,
                          boolean useCase,
                          boolean readOnly)