ResultStorageBase (RaSC API JavaDoc.)

java.lang.Object
- jp.go.nict.isp.wrapper.wisdom.abstractservice.ResultStorageBase<V>

All Implemented Interfaces:

ResultStorage<V>, ResultStorageStreaming<V>

Direct Known Subclasses:

ResultStorageCachedBase, ResultStorageMultiKey
```
public class ResultStorageBase<V>
extends Object
implements ResultStorage<V>, ResultStorageStreaming<V>
```
ResultStorageBaseクラス.
ResultStorage、ResultStorageStreamingの実装クラス.
ストレージクラスの実装クラスである、独自のストレージクラスを実装する場合には、本クラスから派生して実装する.
本クラスでは、サービス連携での検索結果の保持や、フィルタリング、ソートなどの機構を実装する。

Field Summary

Fields
Modifier and Type	Field and Description
`protected V[]`	`arrayResultType`
`protected List<V>`	`errorResult`
`protected ResultRecordFilter<V>`	`filter`
`protected Set<V>`	`resultSet`
`protected static ThreadLocal<Map<String,Comparator<?>>>`	`safeComparator`
`protected static ThreadLocal<Map<String,ResultRecordFilter<?>>>`	`safeFilter`
`protected static ThreadLocal<Map<String,ResultRecordSort<?>>>`	`safeSoter`
`protected AbstractServerModuleBase`	`serverBase`

Constructor Summary

Constructors
Constructor and Description

ResultStorageBase(AbstractServerModuleBase serverBase, V[] arrayResultType)
コンストラクタ

Constructors
Constructor and Description
`ResultStorageBase(AbstractServerModuleBase serverBase, V[] arrayResultType)` コンストラクタ

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkFilter(V result)` 結果レコードをフィルタチェックする
`boolean`	`contains(V result)` 結果と同じレコードを処理済みかチェックする
`List<V>`	`getError()` ストリーミングでの結果通知に失敗した検索結果を取得する
`List<V>`	`getResult()` ストレージから検索結果を取り出す
`protected Comparator<V>`	`loadComparator()` コンパレータをロードする.
`protected ResultRecordFilter<V>`	`loadFilter()` フィルターをロードする.
`protected ResultRecordSort<V>`	`loadSorter()` ソーターをロードする.
`void`	`pushError(V result)` ストリーミングでの結果通知に失敗したデータをストレージに格納する
`boolean`	`pushResult(V result)` 検索結果をストレージに格納する

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - resultSet
```
protected final Set<V> resultSet
```
  - serverBase
```
protected final AbstractServerModuleBase serverBase
```
  - safeComparator
```
protected static final ThreadLocal<Map<String,Comparator<?>>> safeComparator
```
  - safeSoter
```
protected static final ThreadLocal<Map<String,ResultRecordSort<?>>> safeSoter
```
  - safeFilter
```
protected static final ThreadLocal<Map<String,ResultRecordFilter<?>>> safeFilter
```
  - arrayResultType
```
protected final V[] arrayResultType
```
  - filter
```
protected final ResultRecordFilter<V> filter
```
  - errorResult
```
protected final List<V> errorResult
```
- Constructor Detail
  - ResultStorageBase
```
public ResultStorageBase(AbstractServerModuleBase serverBase,
                         V[] arrayResultType)
```
    コンストラクタ
    
    Parameters:
    
    serverBase - サーバーベースオブジェクト
    
    arrayResultType - 検索結果の結果型
- Method Detail
  - pushResult
```
public boolean pushResult(V result)
```
    Description copied from interface: ResultStorage
    
    検索結果をストレージに格納する
    
    Specified by:
    
    pushResult in interface ResultStorage<V>
    
    Parameters:
    
    result - 検索結果
    
    Returns:
    
    true:終了条件に到達(検索件数の上限到達など) false:処理を継続
  - getResult
```
public List<V> getResult()
```
    Description copied from interface: ResultStorage
    
    ストレージから検索結果を取り出す
    
    Specified by:
    
    getResult in interface ResultStorage<V>
    
    Returns:
    
    検索結果
  - loadComparator
```
protected Comparator<V> loadComparator()
```
    コンパレータをロードする.
    
    Returns:
    
    コンパレータオブジェクト(nullの場合には、設定なし)
  - loadSorter
```
protected ResultRecordSort<V> loadSorter()
```
    ソーターをロードする.
    
    Returns:
    
    ソーターオブジェクト(nullの場合には、設定なし）
  - loadFilter
```
protected ResultRecordFilter<V> loadFilter()
```
    フィルターをロードする.
    
    Returns:
    
    フィルターオブジェクト(nullの場合には、設定なし)
  - contains
```
public boolean contains(V result)
```
    Description copied from interface: ResultStorageStreaming
    
    結果と同じレコードを処理済みかチェックする
    
    Specified by:
    
    contains in interface ResultStorageStreaming<V>
    
    Parameters:
    
    result - 結果レコード
    
    Returns:
    
    true:処理済み、false:未処理
  - checkFilter
```
public boolean checkFilter(V result)
```
    Description copied from interface: ResultStorageStreaming
    
    結果レコードをフィルタチェックする
    
    Specified by:
    
    checkFilter in interface ResultStorageStreaming<V>
    
    Parameters:
    
    result - 結果レコード
    
    Returns:
    
    ture:フィルタ対象/false:フィルタ対象ではない
  - pushError
```
public void pushError(V result)
```
    Description copied from interface: ResultStorage
    
    ストリーミングでの結果通知に失敗したデータをストレージに格納する
    
    Specified by:
    
    pushError in interface ResultStorage<V>
    
    Parameters:
    
    result - 検索結果
  - getError
```
public List<V> getError()
```
    Description copied from interface: ResultStorage
    
    ストリーミングでの結果通知に失敗した検索結果を取得する
    
    Specified by:
    
    getError in interface ResultStorage<V>
    
    Returns:
    
    検索結果

Copyright (C) 2014 Information Analysis Laboratory, NICT

RaSC is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option) any later version.
RaSC is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see (http://www.gnu.org/licenses/) .

Class ResultStorageBase<V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

resultSet

serverBase

safeComparator

safeSoter

safeFilter

arrayResultType

filter

errorResult

Constructor Detail

ResultStorageBase

Method Detail

pushResult

getResult

loadComparator

loadSorter

loadFilter

contains

checkFilter

pushError

getError