com.ibm.dtfj.analyzer.helpers.base
Class SectionsTableBase

java.lang.Object
  extended by TranslatableAnalyzer
      extended by com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
          extended by com.ibm.dtfj.analyzer.helpers.base.SectionsTableBase
All Implemented Interfaces:
IAnalyzerBase, IReport, IWrapper
Direct Known Subclasses:
AllBytecodeMethods, AllCompiledMethods, AllImageThreads, AllJavaHeaps, AllJavaThreads, AllLibraries, AllMemorySections

public abstract class SectionsTableBase
extends SimpleAnalyzerBean

A common base class for analyzers that represent an arbitrary list of ImageSections


Constructor Summary
SectionsTableBase()
          Null constructor for use as JavaBean
 
Method Summary
 OneImageSection findContainingSection(com.ibm.dtfj.image.ImagePointer ptr)
          Find the section in the list that contain a given pointer
 OneImageSection findContainingSection(long addr)
          Find the section in the list that contain a given address (specified as a numeric value)
 OneImageSection findContainingSection(OneImageSection ois)
          Find the section in the list that contain another given section
 java.util.Iterator getAllSections()
           
 int getAllSectionsCount()
           
 long getAllSectionsSize()
           
 java.lang.String getAllSectionsSizeAsString()
           
 int getCachingPriority()
          Return 10 to force caching all analyzers that keep a list of sections (to preserve the content summary)
protected  void initializeOneSection(com.ibm.dtfj.image.ImageSection s)
          Add one ImageSection object to the list of sections represented by this object.
protected  void initializeOneSection(OneImageSection ois)
          Add one OneImageSection object to the list of sections represented by this object.
protected  void setChildInitializationHelper(InitializationHelper childInitializationHelper)
          Specify an InitializationHelper object that will be responsible for initialzing the list of sections represented by the current object.
 
Methods inherited from class com.ibm.dtfj.analyzer.base.SimpleAnalyzerBean
allocateReport, allocateReportOptions, allocateSecondaryReport, getCategories, getContext, getIdentityString, getInstance, getLogger, getLongDescription, getName, getNextValidObject, getParent, getReportExtensionHelper, getResourceBundleName, getShortDescription, getVersion, isPrimaryAnalyzer, printEmbeddedReport, printEmbeddedReport, printEmbeddedReportWithOptions, printEmbeddedReportWithOptions, printReportInfoHeader, produceReport, recordInternalExceptionStatic, setContext, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SectionsTableBase

public SectionsTableBase()
Null constructor for use as JavaBean

Method Detail

getCachingPriority

public int getCachingPriority()
Return 10 to force caching all analyzers that keep a list of sections (to preserve the content summary)

Specified by:
getCachingPriority in interface IAnalyzerBase
Overrides:
getCachingPriority in class SimpleAnalyzerBean
Returns:
the caching priority, as a number between 0 and 10
See Also:
SimpleAnalyzerBean.getCachingPriority()

setChildInitializationHelper

protected void setChildInitializationHelper(InitializationHelper childInitializationHelper)
Specify an InitializationHelper object that will be responsible for initialzing the list of sections represented by the current object. This method is required to allow this class to be self-initializing (by calling the child initializer whenever it needs to initialize itself)

Parameters:
childInitializationHelper - the target InitializationHelper object which will initialize the list of sections.

initializeOneSection

protected void initializeOneSection(OneImageSection ois)
                             throws com.ibm.dtfj.image.DTFJException
Add one OneImageSection object to the list of sections represented by this object. This method is normally invoked by a child analyzer that uses this object to hold a list of its sections.

Parameters:
ois - the OneImageSection object to add to the list of sections
Throws:
com.ibm.dtfj.image.DTFJException

initializeOneSection

protected void initializeOneSection(com.ibm.dtfj.image.ImageSection s)
                             throws com.ibm.dtfj.image.DTFJException
Add one ImageSection object to the list of sections represented by this object. This method is normally invoked by a child analyzer that uses this object to hold a list of its sections.

Parameters:
s - the ImageSection object to add to the list of sections
Throws:
com.ibm.dtfj.image.DTFJException

getAllSectionsCount

public int getAllSectionsCount()
                        throws com.ibm.dtfj.image.DTFJException
Returns:
the total number of sections in this list
Throws:
com.ibm.dtfj.image.DTFJException

getAllSectionsSize

public long getAllSectionsSize()
                        throws com.ibm.dtfj.image.DTFJException
Returns:
the total size of all the sections in this list
Throws:
com.ibm.dtfj.image.DTFJException

getAllSectionsSizeAsString

public java.lang.String getAllSectionsSizeAsString()
                                            throws com.ibm.dtfj.image.DTFJException
Returns:
the total size of all the sections in the list, as a user-friendly string
Throws:
com.ibm.dtfj.image.DTFJException

findContainingSection

public OneImageSection findContainingSection(com.ibm.dtfj.image.ImagePointer ptr)
                                      throws com.ibm.dtfj.image.DTFJException
Find the section in the list that contain a given pointer

Parameters:
ptr - the ImagePointer to check against the list of sections
Returns:
the OneImageSection that contains the given pointer, or null if this pointer is not contained within any of the sections in the list.
Throws:
com.ibm.dtfj.image.DTFJException

findContainingSection

public OneImageSection findContainingSection(long addr)
                                      throws com.ibm.dtfj.image.DTFJException
Find the section in the list that contain a given address (specified as a numeric value)

Parameters:
addr - the numeric address to check against the list of sections
Returns:
the OneImageSection that contains the given address, or null if this pointer is not contained within any of the sections in the list.
Throws:
com.ibm.dtfj.image.DTFJException

findContainingSection

public OneImageSection findContainingSection(OneImageSection ois)
                                      throws com.ibm.dtfj.image.DTFJException
Find the section in the list that contain another given section

Parameters:
ois - the OneImageSection object to check against the list of sections
Returns:
the OneImageSection that contains the given other section, or null if this pointer is not contained within any of the sections in the list.
Throws:
com.ibm.dtfj.image.DTFJException

getAllSections

public java.util.Iterator getAllSections()
                                  throws com.ibm.dtfj.image.DTFJException
Returns:
an iterator that contains all the OneImageSection objects in the list maintained by this object.
Throws:
com.ibm.dtfj.image.DTFJException


© Copyright IBM Corp. 2007, 2008 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.