com.ibm.dse.automaton
Class ProcessorExternalizer

java.lang.Object
  |
  +--com.ibm.dse.base.Externalizer
        |
        +--com.ibm.dse.automaton.ProcessorExternalizer

public class ProcessorExternalizer
extends Externalizer

The ProcessExternalizer class reads processors. The generic SGML file must be specified in DSE.INI in the path settings.files.processor. The tags must be in settings.tags.processors.


Fields inherited from class com.ibm.dse.base.Externalizer
tagClassTable, tagInputStream, TYPE_CONTEXT, TYPE_DATA, TYPE_FORMAT, TYPE_OPERATION, TYPE_PROCESSOR, TYPE_SERVICE, TYPE_SETTINGS, TYPE_TYPE, TYPE_UNKNOWN, TYPE_VIEW
 
Constructor Summary
ProcessorExternalizer()
          This is the default constructor used to create a ProcessorExternalizer object.
ProcessorExternalizer(java.lang.String option, java.io.BufferedInputStream aIniStream)
          This constructor creates a new instance of the ProcessorExternalizer class, Option can be Memory or File.Memory means that all tags are stored in memory.
ProcessorExternalizer(java.lang.String option, java.lang.String pathAndFile)
          This constructor initializes a Processor object.
 
Method Summary
static void addType(Tag aTag)
          This method creates a Type object and initializes it with the information stored in the Tag.
static void clearCache()
          This method empties the cache
 java.lang.Object convertTagToObject(Tag aTag)
          Converts a tag to an object and initializes the object's attributes.
protected  ProcessorExternalizer createNewExternalizer()
          Returns a new externalizer for the generic processor file.
protected  TagInputStream createSelfDefinedProcTagInputStream(java.lang.String aFileProcName, java.lang.String aPathFile)
          Returns a new self-defined TagInputStream for the specified file.
 void end()
          Releases resources from this Externalizer
static Hashtable getCache()
          This method returns the Processor element cache.
static java.util.Date getDateCreationFileByFileName(java.lang.String aProcFileName)
          Returns the date the self-defined processor file aProcFileName was created or modified.
static java.util.Date getDateCreationFileByProcessorName(java.lang.String aProcessorName)
          Returns the date the file containing the self-defined processor aProcessorName was created or modified.
static java.lang.Object getFromCache(java.lang.String key)
          This method will remove a processor element with id=key from the cache and return it.
static java.util.Enumeration getProcessorFileList()
          Returns the list of the self-defined processor file.
 TagInputStream getSelfDefinedProcTagInputStream(java.lang.String aProcFileName)
          Returns the TagInputStream to which the specified aProcFileName key is mapped.
 java.util.Hashtable getSelfDefinedProcTagInputStreams()
          Returns the Hashtable containing the self-defined processors file names as keys and the corresponding TagInputStreams as values.
 TagOutputStream getSelfDefinedProcTagOutputStream(java.lang.String aProcFileName)
          Returns the tagOutputStream of a self-defined processor.
 java.lang.Object[] getSgmlSelfDefinedProcFileName(java.lang.String aProcessorId)
          Returns the self-defined processor file name corresponding to the aProcessorId parameter.
 boolean isCacheable()
          This method finds out if THIS particular object can be cached.
static boolean isCacheEnabled()
          Returns true if processor element caching is possible.
static void linkAttributeRefs(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkAttributeRefs(Tag, TagInputStream, TagInputStream).
static void linkAttributeRefs(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          If parentTag has an attribute named 'context','refFlow','operationName' or 'operationContext' then add to parentTag a subtag that is the referenced tag.
static void linkContext(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkContext(Tag, TagInputStream, TagInputStream).
static void linkContext(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method will add to parentTag (context tag), a subtag that is the parent context.
static void linkRefData(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex)
          Deprecated. Replaced by linkRefData(Tag, Tag, TagInputStream, int, TagInputStream).
static void linkRefData(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex, TagInputStream genericTagInputStream)
          This method replaces parentTag ("refData" tag) with its corresponding real tag.
static void linkReferences(Tag grandParentTag, Tag parentTag, int parentRefTagIndex, TagInputStream theTagInputStream)
          This method alters the tag structure of the tagInputStream for processor files (either DSEPROCESSOR, or a self defined file) by linking all references to their real tags.
protected static void linkReferences(Tag grandParentTag, Tag parentTag, int parentRefTagIndex, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method alters the tag structure of the tagInputStream for processor files (either DSEPROCESSOR, or a self defined file) by linking all references to their real tags.
static void linkRefFmt(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex)
          Deprecated. Replaced by linkRefFmt(Tag, Tag, TagInputStream, int, TagInputStream).
static void linkRefFmt(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex, TagInputStream genericTagInputStream)
          This method replaces parentTag ("refFmt" tag) with its corresponding real tag.
static void linkRefFormat(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkRefFormat(Tag, TagInputStream, TagInputStream).
static void linkRefFormat(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method will add the real corresponding format tag as a subtag to parentTag ("refFormat" tag).
static void linkRefKColl(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkRefKColl(Tag, TagInputStream, TagInputStream).
static void linkRefKColl(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method will add the real corresponding tag as a subtag to parentTag ("refKColl" tag).
static void linkRefOpSteps(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkRefOpSteps(Tag, TagInputStream, TagInputStream).
static void linkRefOpSteps(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method will add the real corresponding tag as a subtag to parentTag ("refOpSteps" tag).
static void linkRefService(Tag parentTag, TagInputStream theTagInputStream)
          Deprecated. Replaced by linkRefService(Tag, TagInputStream, TagInputStream).
static void linkRefService(Tag parentTag, TagInputStream theTagInputStream, TagInputStream genericTagInputStream)
          This method will add the real corresponding tag as a subtag to parentTag ("refService" tag).
static void linkSpecifiedContext(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId)
          Deprecated. Replaced by linkSpecifiedContext(Tag, TagInputStream, String, TagInputStream).
static void linkSpecifiedContext(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId, TagInputStream genericTagInputStream)
          Adds as subtag of the parentTag a context tag called tagId.
static void linkSpecifiedFlow(Tag parentTag, TagInputStream theTagInputStream, java.lang.String flowId)
          Deprecated. Replaced by linkSpecifiedFlow(Tag, TagInputStream, String, TagInputStream).
static void linkSpecifiedFlow(Tag parentTag, TagInputStream theTagInputStream, java.lang.String flowId, TagInputStream genericTagInputStream)
          Finds a flow tag called flowId and adds all its sub tags to the sub tags of the parentTag.
static void linkSpecifiedFormat(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId)
          Deprecated. Replaced by linkSpecifiedFormat(Tag, TagInputStream, String, TagInputStream).
static void linkSpecifiedFormat(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId, TagInputStream genericTagInputStream)
          Adds as subtag of the parentTag a format tag called tagId.
static void linkSpecifiedOperation(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId)
          Deprecated. Replaced by linkSpecifiedOperation(Tag, TagInputStream, String, TagInputStream).
static void linkSpecifiedOperation(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId, TagInputStream genericTagInputStream)
          Adds as subtag of the parentTag a operation tag called tagId.
 void makeTagClassTable()
          Makes the tagClassTable with the values in DSE.INI The path is: settings.tags.processors.
static void putIntoCache(Processor processor)
          This method will place the processor element processor into the cache.
 java.lang.Object readObject(java.lang.String aProcessorId)
          When an application wants to internalize an instance of an processor (generic or self-defined), it calls this method.
 java.lang.Object readObjectNonCache(java.lang.String aProcessorId)
          Returns a new processor instance created from the information stored in the configuration files associated with a given processor id.
 Tag readTag(int index, java.lang.String aProcFileName)
          Returns the Tag with a given index to the tagInputStream corresponding to a self-defined processor file.
 void reset()
          Resets all the generic processors.
 void reset(java.util.Enumeration listTagId)
          Resets the definition of processors which id appears in listTagId.
 void reset(java.lang.String tagId)
          Resets the definition of the processor named tagId.
protected  void reset(java.lang.String aProcessorId, TagInputStream aTagInputStream, Hashtable selfDefinedTagInputStreams)
          Resets the definition of the processor named tagId.
static void resetProcessorFileNamed(java.lang.String aProcFileName)
          Resets all the self-defined processors contained in the file aProcFileName and then removes the TagInputStream corresponding to the self-defined processor file aProcFileName from the Hashtable.
static void resetProcessorNamed(java.lang.String aProcessorName)
          Resets the self-defined processor aProcessorName.
static void setCacheEnabled(boolean newValue)
          This method enables or disables the processor element caching.
 void setSelfDefinedProcTagInputStream(java.lang.String aFileProcName)
          Creates and sets a TagInputStream corresponding to the aFileProcName file.
 void setSelfDefinedProcTagInputStream(java.lang.String aFileProcName, java.lang.String aPathFile)
          Creates and sets a TagInputStream corresponding to the aFileProcName file.
 void setSelfDefinedProcTagInputStream(java.lang.String aKey, TagInputStream aTagInputStream)
          Sets aTagInputStream in the hashtable with the key aKey.
 java.util.Vector tagList(java.lang.String aProcFileName)
          Returns the tags in the stream corresponding to the self-defined processor file aProcFileName.
 Tag tagWithId(java.lang.String aString, java.lang.String aProcFileName)
          Returns the Tag with the ID in the stream corresponding to the self-defined processor file aProcFileName.
 
Methods inherited from class com.ibm.dse.base.Externalizer
getClasses, getTagClassTable, getTagInputStream, getTagOutputStream, isRunTime, readObject, readTag, setRunTime, setTagClassTable, setTagInputStream, tagList, tagWithId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessorExternalizer

public ProcessorExternalizer()
This is the default constructor used to create a ProcessorExternalizer object.

ProcessorExternalizer

public ProcessorExternalizer(java.lang.String option,
                             java.io.BufferedInputStream aIniStream)
                      throws java.io.IOException
This constructor creates a new instance of the ProcessorExternalizer class, Option can be Memory or File.Memory means that all tags are stored in memory. This is recommended with small files.File means that the file is read everytime you need a tag. This is recommended with large files.
Parameters:
option - java.lang.String
aIniStream - java.io.BufferedInputStream

ProcessorExternalizer

public ProcessorExternalizer(java.lang.String option,
                             java.lang.String pathAndFile)
                      throws java.io.IOException
This constructor initializes a Processor object. The option parameter should be Memory" or File. Memory indicates that all tags are to be stored in memory. This is the recommended option for small tag files. File indicates that the tag file is read each time a tag is needed. This is the recommended option for large tag files.
Parameters:
option - java.lang.String
pathAndFile - java.lang.String specifying the name and path of the formats definition file
Method Detail

addType

public static void addType(Tag aTag)
                    throws java.io.IOException
This method creates a Type object and initializes it with the information stored in the Tag. Then it adds this object to the DSETypeExternalizer's list of types.
Parameters:
aTag - com.ibm.dse.base.Tag

clearCache

public static void clearCache()
This method empties the cache

convertTagToObject

public java.lang.Object convertTagToObject(Tag aTag)
                                    throws java.io.IOException
Converts a tag to an object and initializes the object's attributes. Users can specify where to find the processor using the full package name in the processor tag or in the initialization file. To work properly, the class that provides the instance must have a constructor with no arguments.
Overrides:
convertTagToObject in class Externalizer
Parameters:
aTag - Tag
Returns:
Object

createNewExternalizer

protected ProcessorExternalizer createNewExternalizer()
                                               throws java.io.IOException,
                                                      DSEObjectNotFoundException
Returns a new externalizer for the generic processor file.
Returns:
com.ibm.dse.automaton.ProcessorExternalizer
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

createSelfDefinedProcTagInputStream

protected TagInputStream createSelfDefinedProcTagInputStream(java.lang.String aFileProcName,
                                                             java.lang.String aPathFile)
                                                      throws java.io.IOException
Returns a new self-defined TagInputStream for the specified file.
Parameters:
aFileProcName - java.lang.String The name of the file.
aPathFile - java.lang.String The path of the file.
Returns:
TagInputStream
Throws:
java.io.IOException -  

end

public void end()
Releases resources from this Externalizer
Overrides:
end in class Externalizer

getCache

public static Hashtable getCache()
This method returns the Processor element cache.
Returns:
com.ibm.dse.base.Hashtable

getDateCreationFileByFileName

public static java.util.Date getDateCreationFileByFileName(java.lang.String aProcFileName)
Returns the date the self-defined processor file aProcFileName was created or modified.
Parameters:
aProcFileName - java.lang.String the self-defined processor file name.
Returns:
java.util.Date.

getDateCreationFileByProcessorName

public static java.util.Date getDateCreationFileByProcessorName(java.lang.String aProcessorName)
Returns the date the file containing the self-defined processor aProcessorName was created or modified.
Parameters:
aProcessorName - java.lang.String the self-defined processor name (id).
Returns:
java.util.Date.

getFromCache

public static java.lang.Object getFromCache(java.lang.String key)
                                     throws java.io.IOException
This method will remove a processor element with id=key from the cache and return it. If there are no elements in the cache with id=key, then null is returned.
Parameters:
key - java.lang.String
Returns:
java.lang.Object
Throws:
java.io.IOException -  

getProcessorFileList

public static java.util.Enumeration getProcessorFileList()
Returns the list of the self-defined processor file.
Returns:
java.util.Enumeration

getSelfDefinedProcTagInputStream

public TagInputStream getSelfDefinedProcTagInputStream(java.lang.String aProcFileName)
Returns the TagInputStream to which the specified aProcFileName key is mapped.
Parameters:
aProcFileName - java.lang.String
Returns:
com.ibm.dse.base.TagInputStream

getSelfDefinedProcTagInputStreams

public java.util.Hashtable getSelfDefinedProcTagInputStreams()
Returns the Hashtable containing the self-defined processors file names as keys and the corresponding TagInputStreams as values.
Returns:
com.ibm.dse.base.Hashtable

getSelfDefinedProcTagOutputStream

public TagOutputStream getSelfDefinedProcTagOutputStream(java.lang.String aProcFileName)
                                                  throws java.io.IOException
Returns the tagOutputStream of a self-defined processor. This is used only in edit-time.
Parameters:
aProcFileName - String
Returns:
TagOutputStream
Throws:
java.io.IOException -  

getSgmlSelfDefinedProcFileName

public java.lang.Object[] getSgmlSelfDefinedProcFileName(java.lang.String aProcessorId)
Returns the self-defined processor file name corresponding to the aProcessorId parameter.
Parameters:
aProcessorId - java.lang.String
Returns:
java.lang.Object[] Object[0] => Boolean indicating whether the self-defined processor is defined in the .INI file or not Object[1] => file name of the self-defined processor Object[2] => path of the self-defined processor file

isCacheable

public boolean isCacheable()
This method finds out if THIS particular object can be cached.
Returns:
boolean

isCacheEnabled

public static boolean isCacheEnabled()
Returns true if processor element caching is possible. Returns false if it is not possible.
Returns:
boolean

linkAttributeRefs

public static void linkAttributeRefs(Tag parentTag,
                                     TagInputStream theTagInputStream)
                              throws java.io.IOException
Deprecated. Replaced by linkAttributeRefs(Tag, TagInputStream, TagInputStream).

If parentTag has an attribute named 'context','refFlow','operationName' or 'operationContext' then add to parentTag a subtag that is the referenced tag. But if parentTag has an attribute named 'inputMapFmt' or 'outputMapFmt' then add to parentTag a new "refFormat" subtag which in its turn has as subtag the tag referenced in the attribute value.

linkAttributeRefs

public static void linkAttributeRefs(Tag parentTag,
                                     TagInputStream theTagInputStream,
                                     TagInputStream genericTagInputStream)
                              throws java.io.IOException
If parentTag has an attribute named 'context','refFlow','operationName' or 'operationContext' then add to parentTag a subtag that is the referenced tag. But if parentTag has an attribute named 'inputMapFmt' or 'outputMapFmt' then add to parentTag a new "refFormat" subtag which in its turn has as subtag the tag referenced in the attribute value.

linkContext

public static void linkContext(Tag parentTag,
                               TagInputStream theTagInputStream)
                        throws java.io.IOException
Deprecated. Replaced by linkContext(Tag, TagInputStream, TagInputStream).

This method will add to parentTag (context tag), a subtag that is the parent context.

linkContext

public static void linkContext(Tag parentTag,
                               TagInputStream theTagInputStream,
                               TagInputStream genericTagInputStream)
                        throws java.io.IOException
This method will add to parentTag (context tag), a subtag that is the parent context.

linkRefData

public static void linkRefData(Tag parentTag,
                               Tag grandParentTag,
                               TagInputStream theTagInputStream,
                               int parentRefTagIndex)
                        throws java.io.IOException
Deprecated. Replaced by linkRefData(Tag, Tag, TagInputStream, int, TagInputStream).

This method replaces parentTag ("refData" tag) with its corresponding real tag.

linkRefData

public static void linkRefData(Tag parentTag,
                               Tag grandParentTag,
                               TagInputStream theTagInputStream,
                               int parentRefTagIndex,
                               TagInputStream genericTagInputStream)
                        throws java.io.IOException
This method replaces parentTag ("refData" tag) with its corresponding real tag.

linkReferences

public static void linkReferences(Tag grandParentTag,
                                  Tag parentTag,
                                  int parentRefTagIndex,
                                  TagInputStream theTagInputStream)
                           throws java.io.IOException,
                                  DSEObjectNotFoundException
This method alters the tag structure of the tagInputStream for processor files (either DSEPROCESSOR, or a self defined file) by linking all references to their real tags. All real tags are looked for first in the self defined processor file tag stream, and then in the corresponding file tag stream (either data, services, contexts, or formats). The grandParentTag has the parentTag as one of its subtags. The parentTag is the tag that is currently being checked for references. The parentRefTagIndex is the index of the parentTag in the subtags vector of grandParentTag. The theTagInputStream is the input stream which will have its references linked. It can be either the generic processor file (DSEPROCESSOR) or a self-defined processor.
Parameters:
grandParentTag - com.ibm.dse.base.Tag
parentTag - com.ibm.dse.base.Tag
parentRefTagIndex - int
theTagInputStream - com.ibm.dse.base.TagInputStream
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

linkReferences

protected static void linkReferences(Tag grandParentTag,
                                     Tag parentTag,
                                     int parentRefTagIndex,
                                     TagInputStream theTagInputStream,
                                     TagInputStream genericTagInputStream)
                              throws java.io.IOException,
                                     DSEObjectNotFoundException
This method alters the tag structure of the tagInputStream for processor files (either DSEPROCESSOR, or a self defined file) by linking all references to their real tags. All real tags are looked for first in the self defined processor file tag stream, and then in the corresponding file tag stream (either data, services, contexts, or formats). The grandParentTag has the parentTag as one of its subtags. The parentTag is the tag that is currently being checked for references. The parentRefTagIndex is the index of the parentTag in the subtags vector of grandParentTag. The theTagInputStream is the input stream which will have its references linked. It can be either the generic processor file (DSEPROCESSOR) or a self-defined processor. The genericTagInputStream is the input stream to be considered as generic stream in order to solve references.
Parameters:
grandParentTag - com.ibm.dse.base.Tag
parentTag - com.ibm.dse.base.Tag
parentRefTagIndex - int
theTagInputStream - com.ibm.dse.base.TagInputStream
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

linkRefFmt

public static void linkRefFmt(Tag parentTag,
                              Tag grandParentTag,
                              TagInputStream theTagInputStream,
                              int parentRefTagIndex)
                       throws java.io.IOException
Deprecated. Replaced by linkRefFmt(Tag, Tag, TagInputStream, int, TagInputStream).

This method replaces parentTag ("refFmt" tag) with its corresponding real tag.

linkRefFmt

public static void linkRefFmt(Tag parentTag,
                              Tag grandParentTag,
                              TagInputStream theTagInputStream,
                              int parentRefTagIndex,
                              TagInputStream genericTagInputStream)
                       throws java.io.IOException
This method replaces parentTag ("refFmt" tag) with its corresponding real tag.

linkRefFormat

public static void linkRefFormat(Tag parentTag,
                                 TagInputStream theTagInputStream)
                          throws java.io.IOException
Deprecated. Replaced by linkRefFormat(Tag, TagInputStream, TagInputStream).

This method will add the real corresponding format tag as a subtag to parentTag ("refFormat" tag).

linkRefFormat

public static void linkRefFormat(Tag parentTag,
                                 TagInputStream theTagInputStream,
                                 TagInputStream genericTagInputStream)
                          throws java.io.IOException
This method will add the real corresponding format tag as a subtag to parentTag ("refFormat" tag).

linkRefKColl

public static void linkRefKColl(Tag parentTag,
                                TagInputStream theTagInputStream)
                         throws java.io.IOException
Deprecated. Replaced by linkRefKColl(Tag, TagInputStream, TagInputStream).

This method will add the real corresponding tag as a subtag to parentTag ("refKColl" tag).

linkRefKColl

public static void linkRefKColl(Tag parentTag,
                                TagInputStream theTagInputStream,
                                TagInputStream genericTagInputStream)
                         throws java.io.IOException
This method will add the real corresponding tag as a subtag to parentTag ("refKColl" tag).

linkRefOpSteps

public static void linkRefOpSteps(Tag parentTag,
                                  TagInputStream theTagInputStream)
                           throws java.io.IOException
Deprecated. Replaced by linkRefOpSteps(Tag, TagInputStream, TagInputStream).

This method will add the real corresponding tag as a subtag to parentTag ("refOpSteps" tag).

linkRefOpSteps

public static void linkRefOpSteps(Tag parentTag,
                                  TagInputStream theTagInputStream,
                                  TagInputStream genericTagInputStream)
                           throws java.io.IOException
This method will add the real corresponding tag as a subtag to parentTag ("refOpSteps" tag).

linkRefService

public static void linkRefService(Tag parentTag,
                                  TagInputStream theTagInputStream)
                           throws java.io.IOException
Deprecated. Replaced by linkRefService(Tag, TagInputStream, TagInputStream).

This method will add the real corresponding tag as a subtag to parentTag ("refService" tag).

linkRefService

public static void linkRefService(Tag parentTag,
                                  TagInputStream theTagInputStream,
                                  TagInputStream genericTagInputStream)
                           throws java.io.IOException
This method will add the real corresponding tag as a subtag to parentTag ("refService" tag).

linkSpecifiedContext

public static void linkSpecifiedContext(Tag parentTag,
                                        TagInputStream theTagInputStream,
                                        java.lang.String tagId)
                                 throws java.io.IOException
Deprecated. Replaced by linkSpecifiedContext(Tag, TagInputStream, String, TagInputStream).

Adds as subtag of the parentTag a context tag called tagId.

linkSpecifiedContext

public static void linkSpecifiedContext(Tag parentTag,
                                        TagInputStream theTagInputStream,
                                        java.lang.String tagId,
                                        TagInputStream genericTagInputStream)
                                 throws java.io.IOException
Adds as subtag of the parentTag a context tag called tagId.

linkSpecifiedFlow

public static void linkSpecifiedFlow(Tag parentTag,
                                     TagInputStream theTagInputStream,
                                     java.lang.String flowId)
                              throws java.io.IOException
Deprecated. Replaced by linkSpecifiedFlow(Tag, TagInputStream, String, TagInputStream).

Finds a flow tag called flowId and adds all its sub tags to the sub tags of the parentTag.

linkSpecifiedFlow

public static void linkSpecifiedFlow(Tag parentTag,
                                     TagInputStream theTagInputStream,
                                     java.lang.String flowId,
                                     TagInputStream genericTagInputStream)
                              throws java.io.IOException
Finds a flow tag called flowId and adds all its sub tags to the sub tags of the parentTag.

linkSpecifiedFormat

public static void linkSpecifiedFormat(Tag parentTag,
                                       TagInputStream theTagInputStream,
                                       java.lang.String tagId)
                                throws java.io.IOException
Deprecated. Replaced by linkSpecifiedFormat(Tag, TagInputStream, String, TagInputStream).

Adds as subtag of the parentTag a format tag called tagId.

linkSpecifiedFormat

public static void linkSpecifiedFormat(Tag parentTag,
                                       TagInputStream theTagInputStream,
                                       java.lang.String tagId,
                                       TagInputStream genericTagInputStream)
                                throws java.io.IOException
Adds as subtag of the parentTag a format tag called tagId.

linkSpecifiedOperation

public static void linkSpecifiedOperation(Tag parentTag,
                                          TagInputStream theTagInputStream,
                                          java.lang.String tagId)
                                   throws java.io.IOException
Deprecated. Replaced by linkSpecifiedOperation(Tag, TagInputStream, String, TagInputStream).

Adds as subtag of the parentTag a operation tag called tagId.

linkSpecifiedOperation

public static void linkSpecifiedOperation(Tag parentTag,
                                          TagInputStream theTagInputStream,
                                          java.lang.String tagId,
                                          TagInputStream genericTagInputStream)
                                   throws java.io.IOException
Adds as subtag of the parentTag a operation tag called tagId.

makeTagClassTable

public void makeTagClassTable()
Makes the tagClassTable with the values in DSE.INI The path is: settings.tags.processors.
Overrides:
makeTagClassTable in class Externalizer

putIntoCache

public static void putIntoCache(Processor processor)
                         throws java.io.IOException
This method will place the processor element processor into the cache. The processor element will be keyed with the processor name in the cache.
Parameters:
processor - com.ibm.dse.automaton.Processor
Throws:
java.io.IOException -  

readObject

public java.lang.Object readObject(java.lang.String aProcessorId)
                            throws java.io.IOException
When an application wants to internalize an instance of an processor (generic or self-defined), it calls this method. The parameter is the identification of a tag whose type matches the processor class of the element. The instance is initialized with the attributes found in the tag.

If you know the class to be internalized and it implements Externalizable, an alternative way to get the instance is to use:

new MyClass(aString)

If cache is enabled and the given processor exists in it, this instance is returned; if not, the framework creates a new one from the configuration files.
Overrides:
readObject in class Externalizer
Parameters:
aProcessorId - java.lang.String
Returns:
java.lang.Object
Throws:
java.io.IOException. -  

readObjectNonCache

public java.lang.Object readObjectNonCache(java.lang.String aProcessorId)
                                    throws java.io.IOException
Returns a new processor instance created from the information stored in the configuration files associated with a given processor id.
Parameters:
aProcessorId - java.lang.String
Returns:
java.lang.Object
Throws:
java.io.IOException. -  

readTag

public Tag readTag(int index,
                   java.lang.String aProcFileName)
            throws java.io.IOException
Returns the Tag with a given index to the tagInputStream corresponding to a self-defined processor file.
Parameters:
index - int
aProcFileName - java.lang.String the self-defined processor file name where the tag must be searched
Returns:
Tag

reset

public void reset()
           throws java.io.IOException,
                  DSEObjectNotFoundException
Resets all the generic processors. All self-defined definitions are deleted.
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

reset

public void reset(java.lang.String tagId)
           throws java.io.IOException,
                  DSEObjectNotFoundException
Resets the definition of the processor named tagId. The new definition is read from the file associated with this processor.
Parameters:
tagId - java.lang.String The id of the processor to reset.
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

reset

protected void reset(java.lang.String aProcessorId,
                     TagInputStream aTagInputStream,
                     Hashtable selfDefinedTagInputStreams)
              throws java.io.IOException
Resets the definition of the processor named tagId. The new definition is obtained from the temporal TagInputStreams passed by parameter.
Parameters:
aProcessorId - java.lang.String The id of the processor to reset.
aTagInputStream - com.ibm.dse.base.TagInputStream The temporal generic TagInputStream.
selfDefinedTagInputStreams - com.ibm.dse.base.Hashtable The temporal self-defined TagInputStreams.
Throws:
java.io.IOException -  

reset

public void reset(java.util.Enumeration listTagId)
           throws java.io.IOException,
                  DSEObjectNotFoundException
Resets the definition of processors which id appears in listTagId. The new definitions are read from the file associated with the reset processors.
Parameters:
listTagId - java.util.Enumeration
Throws:
java.io.IOException -  
DSEObjectNotFoundException -  

resetProcessorFileNamed

public static void resetProcessorFileNamed(java.lang.String aProcFileName)
Resets all the self-defined processors contained in the file aProcFileName and then removes the TagInputStream corresponding to the self-defined processor file aProcFileName from the Hashtable.
Parameters:
aProcFileName - java.lang.String the name of the self-defined processor file

resetProcessorNamed

public static void resetProcessorNamed(java.lang.String aProcessorName)
Resets the self-defined processor aProcessorName. All the processors included in the same file as aProcessorName>/I> are also reset. The method then removes the TagInputStream corresponding to the self-defined processor file from the Hashtable.
Parameters:
aProcessorName - java.lang.String the name of the processor to reset

setCacheEnabled

public static void setCacheEnabled(boolean newValue)
This method enables or disables the processor element caching. if newValue = true, then object caching is enabled. if newValue = false, then object caching is disabled.
Parameters:
newValue - boolean

setSelfDefinedProcTagInputStream

public void setSelfDefinedProcTagInputStream(java.lang.String aFileProcName)
                                      throws java.io.IOException
Creates and sets a TagInputStream corresponding to the aFileProcName file. The method then adds the new TagInputStream to the Hashtable containing TagInputStream instances corresponding to the self-defined processor files.
Parameters:
aFileProcName - java.lang.String
Throws:
java.io.IOException. -  

setSelfDefinedProcTagInputStream

public void setSelfDefinedProcTagInputStream(java.lang.String aKey,
                                             TagInputStream aTagInputStream)
                                      throws java.io.IOException
Sets aTagInputStream in the hashtable with the key aKey. This stream can read tags.
Parameters:
aKey - java.lang.String
aTagInputStream - aTagInputStream
Throws:
java.io.IOException. -  

setSelfDefinedProcTagInputStream

public void setSelfDefinedProcTagInputStream(java.lang.String aFileProcName,
                                             java.lang.String aPathFile)
                                      throws java.io.IOException
Creates and sets a TagInputStream corresponding to the aFileProcName file. The method then adds the new TagInputStream to the Hashtable containing TagInputStream instances corresponding to the self-defined processor files.
Parameters:
aFileProcName - java.lang.String
aPathFile - java.lang.String
Throws:
java.io.IOException. -  

tagList

public java.util.Vector tagList(java.lang.String aProcFileName)
Returns the tags in the stream corresponding to the self-defined processor file aProcFileName.
Parameters:
aProcFileName - java.lang.String
Returns:
Vector

tagWithId

public Tag tagWithId(java.lang.String aString,
                     java.lang.String aProcFileName)
              throws java.io.IOException
Returns the Tag with the ID in the stream corresponding to the self-defined processor file aProcFileName.
Parameters:
aString - java.lang.String the id of the Tag to search
aProcFileName - java.lang.String the self-defined processor file name where the tag must be searched
Returns:
Tag
Throws:
java.io.IOException -