LIXM 1.6.1M3

org.lixm.core.list
インタフェース XMLCursor


public interface XMLCursor

カーソルはリスト内のモデルの位置情報をカプセル化しまが それ自身ではモデルを取得できません。 その点でイテレータとは違います。

導入されたバージョン:
1.5
バージョン:
1.6.1
作成者:
tasogare
関連項目:
XMLDocumentList

メソッドの概要
 int dec()
           現在位置の一つ前にあるモデルの位置情報を取得します。
 int getFirst()
          リストの初めにあるモデルの位置情報を取得します。
 int getIndex()
          現在位置を返します。
 int getLast()
          リストの最後にあるモデルの位置情報を取得します。
 XMLDocumentList<? extends AbstractModel> getList()
          このカーソルに対応するリストを返します。
 int getMark()
          記憶済み位置情報を返します。
 boolean hasNext()
          現在位置から見て一つ次の位置にまだモデルが存在しているか調べます。
 boolean hasPrevious()
          現在位置から見て一つ前の位置にまだモデルが存在しているか調べます。
 int inc()
          現在位置の一つ次にあるモデルの位置情報を取得します。
 int next()
          現在位置の一つ次にあるモデルの位置情報を取得します。
 int nextTag()
          次に存在する開始タグまたは終了タグの位置情報を取得します。
 int previous()
          現在位置の一つ前にあるモデルの位置情報を取得します。
 int previousTag()
          以前に存在する開始タグまたは終了タグの位置情報を取得します。
 void resetIndex()
          現在位置を初期化されたときの状態に戻します。
 void resetMark()
          記憶済み位置情報を初期化されたときの状態に戻します。
 void seek(int pos)
          現在位置を記憶し、任意の位置を現在位置に設定しなおします。
 void setIndex(int index)
          カーソルの現在位置を設定します。
 void setMark(int index)
          任意の位置情報を記憶します。
 

メソッドの詳細

getFirst

int getFirst()
リストの初めにあるモデルの位置情報を取得します。

戻り値:
この戻り値は常に0になる筈です。

getLast

int getLast()
リストの最後にあるモデルの位置情報を取得します。

戻り値:
この戻り値は常に size() - 1 になる筈です。
関連項目:
XMLModelList.size()

inc

int inc()
        throws java.lang.IndexOutOfBoundsException

現在位置の一つ次にあるモデルの位置情報を取得します。

この時、位置情報を更新します。 リスト内の次の位置にモデルが無い場合、 IndexOutOfBoundsExceptionを投げます。

戻り値:
current + 1となる値が返る。
例外:
java.lang.IndexOutOfBoundsException - hasNext()が偽を返す場合
関連項目:
next(), hasNext()

next

int next()
現在位置の一つ次にあるモデルの位置情報を取得します。 inc()との違いは位置情報を更新しません。

戻り値:
current + 1となる値が返る。

nextTag

int nextTag()
次に存在する開始タグまたは終了タグの位置情報を取得します。

戻り値:
タグモデルを見つけた場合その位置

hasNext

boolean hasNext()
現在位置から見て一つ次の位置にまだモデルが存在しているか調べます。

戻り値:
次にモデルが存在しているなら真、 そうで無いなら偽を返します。
関連項目:
inc(), next()

dec

int dec()
        throws java.lang.IndexOutOfBoundsException

現在位置の一つ前にあるモデルの位置情報を取得します。

この時、位置情報を更新します。 リスト内の前の位置にモデルが無い場合、 IndexOutOfBoundsExceptionを投げます。

戻り値:
current - 1となる値が返る。
例外:
java.lang.IndexOutOfBoundsException
関連項目:
previous(), hasPrevious()

previous

int previous()
現在位置の一つ前にあるモデルの位置情報を取得します。 dec()との違いは位置情報を更新しません。

戻り値:
current - 1となる値が返る。

previousTag

int previousTag()
以前に存在する開始タグまたは終了タグの位置情報を取得します。

戻り値:
タグモデルを見つけた場合その位置

hasPrevious

boolean hasPrevious()
現在位置から見て一つ前の位置にまだモデルが存在しているか調べます。

戻り値:
前にモデルが存在しているなら真、そうで無いなら偽を返します。
関連項目:
dec(), previous()

setIndex

void setIndex(int index)
              throws java.lang.IndexOutOfBoundsException

カーソルの現在位置を設定します。 この値はgetIndex()で取得する場合は絶対的な位置情報となり、 inc()などで取得する場合はこのメソッドで設定した 位置からの相対的な位置情報となります。

パラメータ:
index - 設定する位置情報
例外:
java.lang.IndexOutOfBoundsException - リストの範囲を超える場合 IndexOutOfBoundsExceptionが投げられます。
関連項目:
getIndex(), resetIndex(), inc(), next(), dec(), previous()

getIndex

int getIndex()
現在位置を返します。

戻り値:
現在の絶対的な位置情報
関連項目:
setIndex(int), resetIndex()

resetIndex

void resetIndex()
現在位置を初期化されたときの状態に戻します。

関連項目:
setIndex(int), getIndex()

setMark

void setMark(int index)
             throws java.lang.IndexOutOfBoundsException
任意の位置情報を記憶します。

パラメータ:
index - 記憶する位置情報。
例外:
java.lang.IndexOutOfBoundsException - 実引数がリストの範囲外なら IndexOutOfBoundsExceptionを投げます。
関連項目:
getMark()

getMark

int getMark()
記憶済み位置情報を返します。

戻り値:
記憶済みの位置情報
関連項目:
setMark(int)

resetMark

void resetMark()
記憶済み位置情報を初期化されたときの状態に戻します。

関連項目:
getMark()

seek

void seek(int pos)
          throws java.lang.IndexOutOfBoundsException
現在位置を記憶し、任意の位置を現在位置に設定しなおします。

パラメータ:
pos - 設定する現在位置
例外:
java.lang.IndexOutOfBoundsException - リストの範囲を超える場合 IndexOutOfBoundsExceptionが投げられます。
関連項目:
setMark(int), setIndex(int)

getList

XMLDocumentList<? extends AbstractModel> getList()
このカーソルに対応するリストを返します。

戻り値:
このカーソルに対応するリスト
関連項目:
XMLDocumentList

LIXM 1.6.1M3

Copyright © 2005-2007 tasogare. All rights reserved.