> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IFieldExtractor

> FlexiCapture の抽出スクリプト向け IFieldExtractor オブジェクトリファレンス。NER エンティティの検索、XML クエリの実行、テキストスパンの field への保存を行うメソッドについて説明します。

<div id="purpose">
  ## 目的
</div>

Documentのテキスト内にあるfieldを識別します。

<Note>
  変更できるのは抽出スクリプト内のみです。
</Note>

<div id="methods">
  ## メソッド
</div>

<table width="100%">
  <thead>
    <tr>
      <th>
        <p>
          <strong>Name</strong>
        </p>
      </th>

      <th>
        <p>
          <strong>Description</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>ExtractRegularExpression( regularExpression : string, resultCollectionName : string )</p>
      </td>

      <td>
        <p>テキスト範囲を識別するための正規表現を指定します。</p>

        <p>
          <br />

          resultCollectionName パラメーターは、生成されるオブジェクトのコレクションの名前を設定します。コレクション名は、ドキュメントに対して実行する XML クエリで使用できます。また、生成されたコレクションには、その名前を使ってアクセスすることもできます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ExtractNerObjects()</p>
      </td>

      <td>
        <p>
          フィールド識別機能に、文書のテキスト内にある NER エンティティを識別するよう指示します。オブジェクトが識別されると、フィールド識別機能では、NerPerson、NerOrg、NerGeo、NerAddress、NerMoney、NerDate という事前定義名を持つコレクションを利用できるようになります。
        </p>

        <p>
          <strong>注: </strong> NerMoney オブジェクトと NerDate オブジェクトは、<a href="/ja/flexi-capture/nlp-extraction-scripts">抽出スクリプト</a>でのみ使用され、ABBYY FlexiLayout
          Studio では利用できません。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ExtractWordsFromUserDictionary( userDictionaryName : string, languageName : string )</p>
      </td>

      <td>
        <p>
          フィールド識別メカニズムに対し、Document のテキスト内でユーザー辞書の単語を識別するよう指示します。単語は、テキスト内で任意の活用形で出現する場合があります。ユーザー辞書は、スクリプトルールの \[Properties] タブで{" "}
          <a href="/ja/flexi-capture/nlp-extraction-scripts#dictionary">選択</a>できます。辞書には名前でアクセスされます。
        </p>

        <p>
          <br />

          languageName パラメーターは、ユーザー辞書内の単語の活用形を生成する言語を指定します。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ParseAddress()</p>
      </td>

      <td>
        <p>field またはセクション内のテキストを解析し、住所の各構成要素に分割します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ParseAddressInPosition( resultCollectionNamePrefix : string, startPos : int, endPos : int )</p>
      </td>

      <td>
        <p>field またはセクション内の、指定した開始位置から終了位置までのテキストフラグメントを住所コンポーネントとして解析します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ParseAddressInSpan(resultCollectionNamePrefix : string, span : IInterval )</p>
      </td>

      <td>
        <p>field またはセクション内の指定した区間に含まれるテキストフラグメントを解析し、住所の構成要素に分解します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>PutSpanToField( startPos : int, endPos : int, fieldName : IField )</p>
      </td>

      <td>
        <p>テキストの部分文字列について、指定した範囲に対応するテキスト断片をドキュメントフィールドに保存します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>PutTextToField( startPos : int, endPos : int, fieldName : IField )</p>
      </td>

      <td>
        <p>テキストの部分文字列について指定された開始位置と終了位置に対応するテキストフラグメントを、ドキュメント field に保存します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          RunQuery( xmlQuery : string, queryName : string ) : <a href="/ja/flexi-capture/i-extracted-objects">IExtractedObjects</a>
        </p>
      </td>

      <td>
        <p>ドキュメントのテキストおよび識別されたテキスト範囲に対して XML クエリを実行します。識別された結果の string を含むテキスト範囲の array として、結果の collection を返します。</p>
        <p>queryName parameter ではクエリ名を指定します。この名前は、field 識別メカニズムから結果の collection を取得するために使用できます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>RunQueryAndSaveToField( xmlQuery : string, queryName : string, fieldName : string )</p>
      </td>

      <td>
        <p>ドキュメントのテキストおよび特定されたテキスト範囲に対して XML クエリを実行し、その結果をドキュメントのfieldに保存します。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SaveSpanToField( span : IInterval, fieldName : string )</p>
      </td>

      <td>
        <p>テキストの部分文字列について指定した span に対応するテキスト断片を、ドキュメントの field に保存します。</p>

        <p>
          <strong>重要！ </strong>このメソッドは、FlexiCapture Release 3 Update 4 以降では廃止されています。FlexiCapture Release 3 Update 4 以降の新規プロジェクトでこのメソッドを使用すると、その
          プロジェクトは Exceptions に送られます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SaveTextToField( startPos : int, endPos : int, fieldName : string )</p>
      </td>

      <td>
        <p>テキストの部分文字列について指定した開始位置と終了位置に対応するテキスト フラグメントを、ドキュメント field に保存します。</p>

        <p>
          <strong>重要! </strong>このメソッドは、FlexiCapture Release 3 Update 4 以降では廃止されています。FlexiCapture Release 3 Update 4 以降の新規プロジェクトでこのメソッドを使用すると、そのプロジェクトは
          Exceptions に送られます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ExtractedObjects( collectionName : string, \[optional] objectTypeName : VARIANT) : <a href="/ja/flexi-capture/i-extracted-objects">IExtractedObjects</a>
        </p>
      </td>

      <td>
        <p>コレクション名で識別されるオブジェクトのコレクションにアクセスできます。</p>
        <p>住所コンポーネントとして識別される NER オブジェクトのコレクションについては、次のいずれかを行います。</p>

        <ul>
          <li>
            collectionName には、ParseAddress... メソッドに resultCollectionNamePrefix として渡した名前を使用します。さらに、objectTypeName にコレクションの型名 (例:
            "NerStreet" または "NerCity") を設定するか、
          </li>

          <li>または、objectTypeName をオプション引数として指定せず、collectionName に \[resultCollectionNamePrefix ]\_\[ objectTypeName] を指定します。</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          QueryResults( queryName : string ) : <a href="/ja/flexi-capture/i-extracted-objects">IExtractedObjects</a>
        </p>
      </td>

      <td>
        <p>クエリ名を指定して、XML クエリの結果にアクセスできます。</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## プロパティ
</div>

<table width="100%"><thead><tr><th><p><strong>名前</strong></p></th><th><p><strong>型</strong></p></th><th><p><strong>アクセス許可</strong></p></th><th><p><strong>値</strong></p></th></tr></thead><tbody><tr><td><p>SourceText()</p></td><td><p>string</p></td><td><p>読み取り</p></td><td><p>field の特定メカニズムの適用対象であるDocumentまたは field のテキストです。</p></td></tr><tr><td><p>SourceNode()</p></td><td><p>IField</p></td><td><p>読み取り</p></td><td><p>field の特定メカニズムの適用対象である field またはセクションです。</p></td></tr><tr><td><p>SourceDocument()</p></td><td><p>IDocument</p></td><td><p>読み取り</p></td><td><p>SourceNode を含むDocumentです。</p></td></tr></tbody></table>