Entity

java.lang.Object
- com.scitools.understand.Entity

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()` エンティティの固有名を返します。

クラス java.lang.Objectから継承されたメソッド
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オーバーライド:
    
    equals in class java.lang.Object
  - id
```
public int id()
```
    データベース中で固有な、エンティティのIDを返します。データベースの再解析をおこなった場合、IDの一貫性は保証されません。
    
    戻り値:
    エンティティのID
  - name
```
public java.lang.String name()
```
    エンティティの短い名前を返します。
    
    戻り値:
    エンティティの短い名前
  - uniquename
```
public java.lang.String uniquename()
```
    エンティティの固有名を返します。db.lookup_uniquename()によって、固有名からEntityを得ることができます。
    
    戻り値:
    エンティティの固有名
  - simplename
```
public java.lang.String simplename()
```
    エンティティの単純な名前を返します。
    
    戻り値:
    エンティティの単純な名前
  - longname
```
public java.lang.String longname(boolean preserveNamedRoots)
```
    エンティティの長い名前を返します。長い名前がない場合、name()と同じ短い名前を返します。
    エンティティがファイルで、かつ、前付きルートの設定がおこなわれている場合、通常では名前付きルートは絶対パスに展開されます。preservedNameRootsがtrueの場合、名前付きツールの展開はおこないません。
    
    パラメータ:
    preserveNamedRoots - 名前付きルートを保持する場合true
    
    戻り値:
    エンティティの長い名前
  - refs
```
public Reference[] refs(java.lang.String refkindstring,
               java.lang.String entkindstring,
               boolean unique)
```
    エンティティのリファレンスを返します。パラメーターの設定によって、返すリファレンスをフィルターできます。Return the references for this entity. The parameters can be used to filter results. For more information on kind strings, see the Understand Perl API documentation.
    
    パラメータ:
    refkindstring - 種別フィルター文字列。詳細はPerl APIヘルプを参照してください。nullの場合フィルターなし。
    entkindstring - 種別フィルター文字列。詳細はPerl APIヘルプを参照してください。nullの場合フィルターなし。
    unique - trueの場合、各エンティティの最初のリファレンスのみを返します。
    
    戻り値:
    エンティティのリファレンス
  - kind
```
public Kind kind()
```
    エンティティの種別を返します。
    
    戻り値:
    エンティティの種別
  - metrics
```
public java.lang.String[] metrics()
```
    エンティティで利用可能なメトリクス名を返します。
    
    戻り値:
    メトリクス名
  - metric
```
public java.lang.Number metric(java.lang.String name)
```
    指定されたメトリクスの値を返します。
    
    パラメータ:
    name - メトリクス名。null以外。
    
    戻り値:
    メトリクス値。対応する値がない場合0。
  - metric
```
public java.util.Map<java.lang.String,java.lang.Number> metric(java.lang.String[] names)
```
    指定されたメトリクスの値を返します。メトリクス名と値のマップで返します。
    
    パラメータ:
    names - メトリクス名
    
    戻り値:
    メトリクス名と値のマップ
  - draw
```
public void draw(java.lang.String graph,
        java.lang.String filename,
        java.lang.String options)
          throws UnderstandException
```
    エンティティに関するグラフィクスを生成します。
    パラメータ:
    graph - グラフ名。グラフの種類は、言語およびエンティティにより異なります。指定可能な名称は、Understand GUI上でのグラフ名表記に対応します。例えば、以下の通りです。
    
    "Base Classes"
    "Butterfly"
    "Called By"
    "Control Flow"
    "Calls"
    "Declaration"
    "DependsOn"
    filename - .jpg,.png,.dot,.vdx,.svg いずれかの拡張子で終わるファイル名
    options - グラフ描画に関するオプションを指定することができます。オプション文字列のフォーマットは、"name=value" です。セミコロンで区切ることで複数のオプションを指定できます。複数のオプションを指定する場合、セミコロンで区切ります。書式中でスペースは認識されますが、大文字小文字の区別はされません。name に指定する名称は、各グラフの右クリックメニューに表示される各フィールドに対応します。例えば、以下の通りです。
    
    "Layout=Crossing; name=Fullname;Level=AllLevels"
    "Comments=On;Entity Name=On"
    例外:
    
    UnderstandException
  - ib
```
public 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フィールドを非表示にします。
    
    {Metrics}levels=0;
    {Metrics}=off;
    以下のオプションは、field-nameを指定しない場合のみ有効です。
    Indent - インデントに使用するスペースの数です。デフォルトは2です。
    以下のオプションは、field-nameを指定する場合のみ有効です。いくつかのfield-nameでは、いくつかのオプションが無効です。Understand上でフィールドを右クリックした際のメニューに表示されるオプションのみが有効です。これらのオプションのデフォルト値は、言語やフィールド名により異なります。
    
    Defnfile
    
    Short: エンティティの定義ファイルを短い名前で表示します。
    Long: エンティティの定義ファイルを長い名前で表示します。
    Relative: エンティティの定義ファイルを相対的な名前で表示します。
    Off: エンティティの定義ファイルを表示しません。
    
    Dotrefs
    
    On: リファレンスを長い名前で表示します。
    Off: リファレンスを表示しません。
    
    Filenames
    
    Short: 短いファイル名を表示します。
    Long: 長いファイル名を表示します。
    Relative: 相対的なファイル名を表示します。
    
    Fullname
    
    On: 適切な場合に長いファイル名を表示します。
    Off: 常に短いファイル名を表示します。
    
    Inactives
    
    On: 非アクティブなリファレンスを表示します。
    Off: 非アクティブなリファレンスを表示しません。
    
    Levels
    
    -1: ネストされたフィールドをすべて表示します。
    0: フィールド名とネストされたフィールドを表示しません。
    n: ネストされたフィールドをnで指定された階層まで表示します。デフォルトは4です。
    
    Parameters
    
    On: 関数のパラメーターを表示します。
    Off: 関数のパラメーターを表示しません。
    
    References
    
    On: 複数のリファレンスとそれぞれのファイル名/行を表示します。
    Off: シンプルなリファレンスのみ表示します。
    
    Returntypes
    
    On: 関数の戻り型を表示します。
    Off: 関数の戻り型を表示しません。
    
    Sort
    
    On: 名前でソートします。
    Off: リファレンスのファイル名/行でソートします。
    Ref: リファレンスの種類とファイル名/行でソートします。
    
    Types
    
    On: エンティティの型を表示します。
    Off: エンティティの型を表示しません。
    以下は、パラメーターに指定する文字列の例です。
    "{Metrics}=off;{calls}levels=-1;{callbys}levels=-1;"
    戻り値:
    エンティティに関する情報ブラウザーの情報

クラスEntity

メソッドのサマリー

クラス java.lang.Objectから継承されたメソッド

メソッドの詳細

hashCode

equals

id

name

uniquename

simplename

longname

refs

kind

metrics

metric

metric

draw

ib