|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.dse.base.Externalizer
com.ibm.dse.gui.ViewExternalizer
This Externalizer reads views. The generic views definition file must be specified in the DSE.INI file (in the settings.files.view path) and the self-defined view files must be specified in the DSE.INI file (in the settings.files.views path). The packages that contain the classes must be specified in the DSE.INI file (in the settings.packages.views).
Field Summary |
---|
Fields inherited from class com.ibm.dse.base.Externalizer |
---|
numberOfObjects, tagClassTable, tagInputStream, TYPE_CONTEXT, TYPE_DATA, TYPE_FORMAT, TYPE_OPERATION, TYPE_PROCESSOR, TYPE_SERVICE, TYPE_SETTINGS, TYPE_TYPE, TYPE_UNKNOWN, TYPE_VIEW |
Constructor Summary | |
---|---|
ViewExternalizer()
This is the default constructor used to create an ViewExternalizer object. |
|
ViewExternalizer(java.lang.String option,
java.io.BufferedInputStream aIniStream)
This constructor creates a new instance of the ViewExternalizer class, Option can be Memory or File. |
|
ViewExternalizer(java.lang.String option,
java.lang.String pathAndFile)
This constructor creates a new instance of the ViewExternalizer class, Option can be Memory or File. |
Method Summary | |
---|---|
static void |
addType(Tag aTag)
This method creates a Type object and initializes it with the information stored in the Tag. |
java.lang.Object |
convertTagToObject(Tag aTag)
Converts a tag to an Object. |
void |
end()
Releases resources from this Externalizer |
static java.util.Date |
getDateCreationFileByFileName(java.lang.String aViewFileName)
Returns the date the self-defined view file aViewFileName was created or modified. |
static java.util.Date |
getDateCreationFileByViewName(java.lang.String aViewName)
Returns the date the file containing the self-defined view aViewName was created or modified. |
TagInputStream |
getSelfDefinedViewTagInputStream(java.lang.String aViewFileName)
Returns the TagInputStream to which the specified aViewFileName key is mapped. |
java.util.Hashtable |
getSelfDefinedViewTagInputStreams()
Returns the Hashtable containing the self-defined views file names as keys and the corresponding TagInputStreams as values. |
TagOutputStream |
getSelfDefinedViewTagOutputStream(java.lang.String aViewFileName)
Returns the tagOutputStream of a self-defined view. |
java.lang.Object[] |
getSgmlSelfDefinedViewFileName(java.lang.String aViewId)
Returns the self-defined view file name corresponding to the aViewId parameter. |
static java.util.Enumeration |
getViewFileList()
Returns the list of the self-defined view file. |
static void |
linkContext(Tag parentTag,
TagInputStream theTagInputStream)
This method will add to parentTag (context tag), a subtag that is the parent context. |
static void |
linkOperationContext(Tag parentTag,
TagInputStream theTagInputStream)
This method will add to parentTag (operation tag), a subtag that is the operation context. |
static void |
linkRefData(Tag parentTag,
Tag grandParentTag,
TagInputStream theTagInputStream,
int parentRefTagIndex)
This method replaces parentTag ("refData" tag) with its corresponding real tag. |
static void |
linkReferences(Tag grandParentTag,
Tag parentTag,
int parentRefTagIndex,
int recursiveDepth,
TagInputStream theTagInputStream)
This method alters the tag structure of the tagInputStream for view files (either DSEVIEWS, or a self defined file) by linking all references to their real tags. |
static void |
linkRefFmt(Tag parentTag,
Tag grandParentTag,
TagInputStream theTagInputStream,
int parentRefTagIndex)
This method replaces parentTag ("refFmt" tag) with its corresponding real tag. |
static void |
linkRefFormat(Tag parentTag,
TagInputStream theTagInputStream)
This method will add the real corresponding format tag as a subtag to parentTag ("refFormat" tag). |
static void |
linkRefKColl(Tag parentTag,
TagInputStream theTagInputStream)
This method will add the real corresponding tag as a subtag to parentTag ("refKColl" tag). |
static void |
linkRefOpSteps(Tag parentTag,
TagInputStream theTagInputStream)
This method will add the real corresponding tag as a subtag to parentTag ("refOpSteps" tag). |
static void |
linkRefService(Tag parentTag,
TagInputStream theTagInputStream)
This method will add the real corresponding tag as a subtag to parentTag ("refService" tag). |
static void |
linkView(Tag parentTag,
TagInputStream theTagInputStream)
This method will add to parentTag (view tag), a subtag that is the view context and a subtag that is the default operation. |
static void |
linkViewContext(Tag parentTag,
TagInputStream theTagInputStream,
java.lang.String tagId)
This method will add to parentTag (view tag), a subtag that is the view context. |
static void |
linkViewOperation(Tag parentTag,
TagInputStream theTagInputStream,
java.lang.String tagId)
This method will add to parentTag (view tag), a subtag that is the view default operation. |
java.lang.Object |
readObject(java.lang.String aViewId)
When an application wants to internalize an instance of a view (generic or self-defined), it calls this method. |
Tag |
readTag(int index,
java.lang.String aViewFileName)
Returns the Tag with a given index to the tagInputStream corresponding to a self-defined view file. |
static void |
resetViewFileNamed(java.lang.String aViewFileName)
Resets all the self-defined views contained in the file aViewFileName and then removes the TagInputStream corresponding to the self-defined view file aViewFileName from the Hashtable. |
static void |
resetViewNamed(java.lang.String aViewName)
Resets the self-defined view aViewName. |
void |
setSelfDefinedViewTagInputStream(java.lang.String aFileViewName)
Creates and sets a TagInputStream corresponding to the aFileViewName file. |
void |
setSelfDefinedViewTagInputStream(java.lang.String aFileViewName,
java.lang.String aPathFile)
Creates and sets a TagInputStream corresponding to the aFileViewName file. |
void |
setSelfDefinedViewTagInputStream(java.lang.String aKey,
TagInputStream aTagInputStream)
Sets aTagInputStream in the hashtable with the key aKey. |
java.util.Vector |
tagList(java.lang.String aViewFileName)
Returns the tags in the stream corresponding to the self-defined view file aViewFileName. |
Tag |
tagWithId(java.lang.String aString,
java.lang.String aViewFileName)
Returns the Tag with the ID in the stream corresponding to the self-defined view file aViewFileName. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ViewExternalizer()
public ViewExternalizer(java.lang.String option, java.io.BufferedInputStream aIniStream) throws java.io.IOException
option
- java.lang.StringaIniStream
- java.io.BufferedInputStreampublic ViewExternalizer(java.lang.String option, java.lang.String pathAndFile) throws java.io.IOException
option
- java.lang.StringpathAndFile
- java.lang.StringMethod Detail |
public static void addType(Tag aTag) throws java.io.IOException
aTag
- com.ibm.dse.base.Tag
java.io.IOException
public java.lang.Object convertTagToObject(Tag aTag) throws java.io.IOException
convertTagToObject
in class Externalizer
aTag
- Tag
java.io.IOException
public void end()
end
in class Externalizer
public static java.util.Date getDateCreationFileByFileName(java.lang.String aViewFileName)
aViewFileName
- java.lang.String the self-defined view file name.
public static java.util.Date getDateCreationFileByViewName(java.lang.String aViewName)
aViewName
- java.lang.String the self-defined view name (id).
public TagInputStream getSelfDefinedViewTagInputStream(java.lang.String aViewFileName)
aViewFileName
- java.lang.String
public java.util.Hashtable getSelfDefinedViewTagInputStreams()
public TagOutputStream getSelfDefinedViewTagOutputStream(java.lang.String aViewFileName) throws java.io.IOException
aViewFileName
- String
java.io.IOException
public java.lang.Object[] getSgmlSelfDefinedViewFileName(java.lang.String aViewId)
aViewId
- java.lang.String
public static java.util.Enumeration getViewFileList()
public static void linkContext(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkOperationContext(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkRefData(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex) throws java.io.IOException
java.io.IOException
public static void linkReferences(Tag grandParentTag, Tag parentTag, int parentRefTagIndex, int recursiveDepth, TagInputStream theTagInputStream) throws java.io.IOException, DSEObjectNotFoundException
grandParentTag
- com.ibm.dse.base.TagparentTag
- com.ibm.dse.base.TagparentRefTagIndex
- intrecursiveDepth
- inttheTagInputStream
- com.ibm.dse.base.TagInputStream
java.io.IOException
DSEObjectNotFoundException
public static void linkRefFmt(Tag parentTag, Tag grandParentTag, TagInputStream theTagInputStream, int parentRefTagIndex) throws java.io.IOException
java.io.IOException
public static void linkRefFormat(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkRefKColl(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkRefOpSteps(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkRefService(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkView(Tag parentTag, TagInputStream theTagInputStream) throws java.io.IOException
java.io.IOException
public static void linkViewContext(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId) throws java.io.IOException
java.io.IOException
public static void linkViewOperation(Tag parentTag, TagInputStream theTagInputStream, java.lang.String tagId) throws java.io.IOException
java.io.IOException
public java.lang.Object readObject(java.lang.String aViewId) throws java.io.IOException
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)
readObject
in class Externalizer
aViewId
- java.lang.String
java.io.IOException.
java.io.IOException
public Tag readTag(int index, java.lang.String aViewFileName) throws java.io.IOException
index
- intaViewFileName
- java.lang.String the self-defined view file name where the tag must be searched
java.io.IOException
public static void resetViewFileNamed(java.lang.String aViewFileName)
public static void resetViewNamed(java.lang.String aViewName)
aViewName
- java.lang.String the name of the view to resetpublic void setSelfDefinedViewTagInputStream(java.lang.String aFileViewName) throws java.io.IOException
aFileViewName
- java.lang.String
java.io.IOException.
java.io.IOException
public void setSelfDefinedViewTagInputStream(java.lang.String aFileViewName, java.lang.String aPathFile) throws java.io.IOException
aFileViewName
- java.lang.StringaPathFile
- java.lang.String
java.io.IOException.
java.io.IOException
public void setSelfDefinedViewTagInputStream(java.lang.String aKey, TagInputStream aTagInputStream) throws java.io.IOException
aKey
- java.lang.StringaTagInputStream
- aTagInputStream
java.io.IOException.
java.io.IOException
public java.util.Vector tagList(java.lang.String aViewFileName)
aViewFileName
- java.lang.String
public Tag tagWithId(java.lang.String aString, java.lang.String aViewFileName) throws java.io.IOException
aString
- java.lang.String the id of the Tag to searchaViewFileName
- java.lang.String the self-defined view file name where the tag must be searched
java.io.IOException
|
IBM Branch Transformation Toolkit Javadoc | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |