| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
| <HTML>
|
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
| <title>Report</title>
|
| <style type="text/css">@import url("file:/C:/Users/IBM_ADMIN/eclipse/configuration/org.eclipse.osgi/bundles/1230/1/.cp/book.css");</style>
|
| <style type="text/css">@import url("file:/C:/Users/IBM_ADMIN/eclipse/configuration/org.eclipse.osgi/bundles/1230/1/.cp/schema.css");</style>
|
| </HEAD>
|
| <BODY>
|
| <H1 style="text-align:center">Report</H1>
|
| <p></p>
|
| <h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.mat.api.report<p></p>
|
| <h6 class="CaptionFigColumn SchemaHeader">Since: </h6>0.7.0
|
| <p></p>
|
|
|
| <h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Reports specify a number of queries which are executed |
| in batch mode and are rendered into HTML files and zipped |
| for easy distribution. Reports can be run from the command |
| line by specifying the report id: |
| <pre class="Example"><span class="code SchemaTag"> |
| MemoryAnalyzer.exe <heap dump> <report id> |
| </span></pre><p></p>
|
| <h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
|
| <p></p>
|
| <p class="code SchemaDtd"><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.report">report</a>)+></p>
|
| <p class="code SchemaDtd"><!ATTLIST extension</p>
|
| <p class="code SchemaDtdAttlist">point CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name CDATA #IMPLIED</p>></p>
|
| <p></p>
|
| <ul class="ConfigMarkupAttlistDesc">
|
| </ul>
|
| <br><p class="code SchemaDtd"><!ELEMENT <a name="e.report">report</a> EMPTY></p>
|
| <p class="code SchemaDtd"><!ATTLIST report</p>
|
| <p class="code SchemaDtdAttlist">id CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">file CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">description CDATA #IMPLIED</p>></p>
|
| <p></p>
|
| <ul class="ConfigMarkupAttlistDesc">
|
| <li><b>id</b> - The unique id of the report. Used when running the report from the command line or when including the report into another report via the template element.</li>
|
| <li><b>name</b> - Display name to be displayed in menus.</li>
|
| <li><b>file</b> - The XML file defining the report.</li>
|
| <li><b>description</b> - Description to be displayed in the status line and/or welcome page.</li>
|
| </ul>
|
| <br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><p> |
| Following is an example of a report declaration: |
| <pre class="Example"><span class="code SchemaTag"> |
| <extension point=</span><span class="code SchemaCstring">"org.eclipse.mat.report.report"</span><span class="code SchemaTag">> |
| <report id=</span><span class="code SchemaCstring">"suspects"</span><span class="code SchemaTag"> name=</span><span class="code SchemaCstring">"Leak Suspects"</span><span class="code SchemaTag"> |
| description=</span><span class="code SchemaCstring">"includes leak suspects and a system overview"</span><span class="code SchemaTag"> |
| file=</span><span class="code SchemaCstring">"META-INF/reports/suspects.xml"</span><span class="code SchemaTag"> /> |
| </extension> |
| </span></pre> |
| </p> |
| <p> |
| Following is a sample report: |
| <pre class="Example"><span class="code SchemaTag"> |
| <section name=</span><span class="code SchemaCstring">"Leak Suspects"</span><span class="code SchemaTag">> |
| <section name=</span><span class="code SchemaCstring">"System Overview"</span><span class="code SchemaTag">> |
| <param key=</span><span class="code SchemaCstring">"html.separate_file"</span><span class="code SchemaTag"> value=</span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag"> /> |
| <template>org.eclipse.mat.api:overview</template> |
| </section> |
| |
| <query name=</span><span class="code SchemaCstring">"Leaks"</span><span class="code SchemaTag">> |
| <command>leakhunter</command> |
| </query> |
| </section> |
| </span></pre> |
| </p> |
| In short: sections contain other sections or queries. Queries specify the command to be run. |
| Sections can contain a template element which specifies another report to be included here.
|
| <p></p>
|
|
|
| <h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>See report.xsd for an XML schema for the report definition.
|
| <p></p>
|
|
|
| <h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The Memory Analyzer supplies a number of reports itself. Check out the <samp>org.eclipse.mat.api</samp> plug-in.
|
| <p></p>
|
|
|
| <br>
|
| <p class="note SchemaCopyright">
|
| Copyright (c) 2008,2010 SAP AG and IBM Corporation.<br> |
| All rights reserved. This program and the accompanying materials are made |
| available under the terms of the Eclipse Public License v1.0 which |
| accompanies this distribution, and is available at |
| <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>
|
|
|
| </p>
|
| </BODY>
|
| </HTML>
|
