public class Entity
extends java.lang.Object
| 修飾子と型 | メソッドと説明 |
|---|---|
void |
draw(java.lang.String graph,
java.lang.String filename,
java.lang.String options)
エンティティに関するグラフィクスを生成します。
|
boolean |
equals(java.lang.Object obj) |
int |
hashCode() |
java.lang.String[] |
ib(java.lang.String options)
エンティティに関する情報ブラウザーの情報を返します。
|
int |
id()
データベース中で固有な、エンティティのIDを返します。
|
Kind |
kind()
エンティティの種別を返します。
|
java.lang.String |
longname(boolean preserveNamedRoots)
エンティティの長い名前を返します。長い名前がない場合、name()と同じ短い名前を返します。
|
java.lang.Number |
metric(java.lang.String name)
指定されたメトリクスの値を返します。
|
java.util.Map<java.lang.String,java.lang.Number> |
metric(java.lang.String[] names)
指定されたメトリクスの値を返します。
|
java.lang.String[] |
metrics()
エンティティで利用可能なメトリクス名を返します。
|
java.lang.String |
name()
エンティティの短い名前を返します。
|
Reference[] |
refs(java.lang.String refkindstring,
java.lang.String entkindstring,
boolean unique)
エンティティのリファレンスを返します。
|
java.lang.String |
simplename()
エンティティの単純な名前を返します。
|
java.lang.String |
uniquename()
エンティティの固有名を返します。
|
public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Objectpublic int id()
public java.lang.String name()
public java.lang.String uniquename()
public java.lang.String simplename()
public java.lang.String longname(boolean preserveNamedRoots)
preserveNamedRoots - 名前付きルートを保持する場合truepublic Reference[] refs(java.lang.String refkindstring, java.lang.String entkindstring, boolean unique)
refkindstring - 種別フィルター文字列。詳細はPerl APIヘルプを参照してください。nullの場合フィルターなし。entkindstring - 種別フィルター文字列。詳細はPerl APIヘルプを参照してください。nullの場合フィルターなし。unique - trueの場合、各エンティティの最初のリファレンスのみを返します。public Kind kind()
public java.lang.String[] metrics()
public java.lang.Number metric(java.lang.String name)
name - メトリクス名。null以外。public java.util.Map<java.lang.String,java.lang.Number> metric(java.lang.String[] names)
names - メトリクス名public void draw(java.lang.String graph,
java.lang.String filename,
java.lang.String options)
throws UnderstandException
graph - グラフ名。グラフの種類は、言語およびエンティティにより異なります。指定可能な名称は、Understand GUI上でのグラフ名表記に対応します。例えば、以下の通りです。filename - .jpg,.png,.dot,.vdx,.svg いずれかの拡張子で終わるファイル名options - グラフ描画に関するオプションを指定することができます。オプション文字列のフォーマットは、"name=value" です。セミコロンで区切ることで複数のオプションを指定できます。 複数のオプションを指定する場合、セミコロンで区切ります。書式中でスペースは認識されますが、大文字小文字の区別はされません。name に指定する名称は、各グラフの右クリックメニューに表示される各フィールドに対応します。例えば、以下の通りです。UnderstandExceptionpublic java.lang.String[] ib(java.lang.String options)
options - 生成されるテキストのフォーマットを指定することができます。オプション文字列の書式は、"name=value" または "{field-name}name=value" です。 複数のオプションを指定する場合、セミコロンで区切ります。書式中でスペースは認識されますが、大文字小文字の区別はされません。 field-name に指定する名称は、情報ブラウザー上に表示される各フィールドに対応します。フィールドがネストされている場合、指定する名称は、それらを連結したものになります。例えば、C++ の場合、Macro フィールドは Local フィールドにネストされますが、この場合、指定する名称は "Local Macros" となります。フィールドとそのサブフィールドは、levels=0またはfield offを指定することで表示されます。例えば、以下の例はいずれも、Metricsフィールドを非表示にします。
Indent - インデントに使用するスペースの数です。デフォルトは2です。
以下のオプションは、field-nameを指定する場合のみ有効です。いくつかのfield-nameでは、いくつかのオプションが無効です。Understand上でフィールドを右クリックした際のメニューに表示されるオプションのみが有効です。これらのオプションのデフォルト値は、言語やフィールド名により異なります。
"{Metrics}=off;{calls}levels=-1;{callbys}levels=-1;"