IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.tools.migration.btttags
Class TagInputStream

java.lang.Object
  extended bycom.ibm.dse.base.TagInputStream
      extended bycom.ibm.btt.tools.migration.btttags.TagInputStream

public class TagInputStream
extends TagInputStream

TagInputStream


Field Summary
 
Fields inherited from class com.ibm.dse.base.TagInputStream
_isSimpleTag, _tagCharArray, _tagLength, bufferedReader, DEFAULT_TAG_SIZE, DEFAULT_TAG_SIZE_INCREMENT, inputStream, sgmlFile, tagIndexes
 
Constructor Summary
TagInputStream(java.io.BufferedInputStream aIniStream, java.lang.String kindOfFile)
          This constructor creates a TagInputStream object to read from aIniStream.
TagInputStream(java.io.BufferedInputStream aIniStream, java.lang.String kindOfFile, boolean isSelfDefined)
          This constructor creates a TagInputStream object to read from aIniStream.
TagInputStream(java.lang.String fileName, java.lang.String kindOfFile)
          This constructor creates a TagInputStream object to read from the specified file.
TagInputStream(java.net.URL aURL, java.lang.String kindOfFile)
          This constructor creates a TagInputStream object to read from the specified file.
TagInputStream(java.util.zip.ZipInputStream zip, java.lang.String fileName, java.lang.String kindOfFile)
          This constructor creates a TagInputStream object to read from the specified zip file.
 
Method Summary
 void createComposedTag(Tag aTag, java.lang.String fileTitle, ProgressIndicator pi, boolean isXmlFile)
          Adds the subtags to aTag to create a composed tag.
 void createComposedTag(Tag aTag, java.lang.String fileTitle, ProgressIndicator pi, boolean isXmlFile, Tag.TagStringReader aReader)
          Adds the subtags to aTag to create a composed tag.
 Vector getTags()
          Returns the tags.
 void initialize(java.io.BufferedInputStream aIniStream, java.lang.String kindOfFile, boolean isSelfDefined)
          Initializes the stream.
 void initialize(java.lang.String fileName, java.lang.String kindOfFile)
          Initializes the stream that reads the specified file.
 void initialize(java.net.URL aURL, java.lang.String kindOfFile)
          Initializes the stream reading from the URL.
 void initialize(java.util.zip.ZipInputStream zip, java.lang.String fileName, java.lang.String kindOfFile)
          Initializes the stream that reads the specified zip file.
 
Methods inherited from class com.ibm.dse.base.TagInputStream
close, createComposedTag, createComposedTag, first, getDateCreationFile, getExternalizer, getInputStream, getKindOfFile, getSgmlFile, getSgmlFileTitle, getTag, getTagIndexes, getTagString, getTagString, initialize, isDecorator, isSimpleTag, last, read, readObject, readTag, removeTagWithId, reset, setDate, setDate, setDate, setExternalizer, setKindOfFile, setSgmlFile, setTagIndexes, setTags, skip, tagWithId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagInputStream

public TagInputStream(java.io.BufferedInputStream aIniStream,
                      java.lang.String kindOfFile)
               throws java.io.IOException
This constructor creates a TagInputStream object to read from aIniStream.

Parameters:
aIniStream - BufferedInputStream
kindOfFile - java.lang.String

TagInputStream

public TagInputStream(java.io.BufferedInputStream aIniStream,
                      java.lang.String kindOfFile,
                      boolean isSelfDefined)
               throws java.io.IOException
This constructor creates a TagInputStream object to read from aIniStream.

Parameters:
aIniStream - BufferedInputStream
kindOfFile - java.lang.String
isSelfDefined - boolean

TagInputStream

public TagInputStream(java.lang.String fileName,
                      java.lang.String kindOfFile)
               throws java.io.IOException
This constructor creates a TagInputStream object to read from the specified file.

Parameters:
fileName - java.lang.String
kindOfFile - java.lang.String

TagInputStream

public TagInputStream(java.net.URL aURL,
                      java.lang.String kindOfFile)
               throws java.io.IOException
This constructor creates a TagInputStream object to read from the specified file.

Parameters:
aURL - java.net.URL
kindOfFile - java.lang.String

TagInputStream

public TagInputStream(java.util.zip.ZipInputStream zip,
                      java.lang.String fileName,
                      java.lang.String kindOfFile)
               throws java.io.IOException
This constructor creates a TagInputStream object to read from the specified zip file.

Parameters:
zip - ZipInputStream
fileName - java.lang.String
kindOfFile - java.lang.String
Method Detail

getTags

public Vector getTags()
Returns the tags.

Overrides:
getTags in class TagInputStream
Returns:
Vector

createComposedTag

public void createComposedTag(Tag aTag,
                              java.lang.String fileTitle,
                              ProgressIndicator pi,
                              boolean isXmlFile)
                       throws java.io.IOException
Adds the subtags to aTag to create a composed tag.

Parameters:
aTag - The tag that has to turn into a composed tag
fileTitle - The file name without its path.
pi - ProgressIndicator.
Throws:
java.io.IOException.
java.io.IOException

createComposedTag

public void createComposedTag(Tag aTag,
                              java.lang.String fileTitle,
                              ProgressIndicator pi,
                              boolean isXmlFile,
                              Tag.TagStringReader aReader)
                       throws java.io.IOException
Adds the subtags to aTag to create a composed tag.

Parameters:
aTag - the tag that has to turn into a composed tag
fileTitle - the file name without its path.
pi - ProgressIndicator.
Throws:
java.io.IOException.
java.io.IOException

initialize

public void initialize(java.io.BufferedInputStream aIniStream,
                       java.lang.String kindOfFile,
                       boolean isSelfDefined)
                throws java.io.IOException
Initializes the stream.

Overrides:
initialize in class TagInputStream
Parameters:
aIniStream - BufferedInputStream
kindOfFile - java.lang.String
isSelfDefined - boolean
Throws:
java.io.IOException.
java.io.IOException

initialize

public void initialize(java.lang.String fileName,
                       java.lang.String kindOfFile)
                throws java.io.IOException
Initializes the stream that reads the specified file.

Overrides:
initialize in class TagInputStream
Parameters:
fileName - java.lang.String
kindOfFile - java.lang.String
Throws:
java.io.IOException.
java.io.IOException

initialize

public void initialize(java.net.URL aURL,
                       java.lang.String kindOfFile)
                throws java.io.IOException
Initializes the stream reading from the URL.

Overrides:
initialize in class TagInputStream
Parameters:
aURL - java.net.URL
kindOfFile - java.lang.String
Throws:
java.io.IOException.
java.io.IOException

initialize

public void initialize(java.util.zip.ZipInputStream zip,
                       java.lang.String fileName,
                       java.lang.String kindOfFile)
                throws java.io.IOException
Initializes the stream that reads the specified zip file.

Overrides:
initialize in class TagInputStream
Parameters:
zip - java.util.zip.ZipInputStream
fileName - java.lang.String
kindOfFile - java.lang.String
Throws:
java.io.IOException.
java.io.IOException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005