ListResultBean (DBFlute Runtime 1.1.0-sp5-RC1 API)

java.lang.Object
- org.dbflute.cbean.result.ListResultBean<ENTITY>

型パラメータ:: ENTITY - The type of entity for the element of selected list.

すべての実装されたインタフェース:: Serializable, Iterable<ENTITY>, Collection<ENTITY>, List<ENTITY>

直系の既知のサブクラス:: PagingResultBean

public class ListResultBean<ENTITY>
extends Object
implements List<ENTITY>, Serializable

The result bean for list.
You can treat it as normal List, because this implements java.util.List.

 [Extension Method]
 mappingList()  : mapping to other class, and returns as list
 groupingList() : grouping the list per category, and returns as list
 groupingMap()  : grouping the list per category, and returns as map
 extractColumnList() : extract one column as value list
 extractColumnSet()  : extract one column as value list

作成者:: jflute
関連項目:: 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected int`	`_allRecordCount` The count of all record.
`protected OrderByClause`	`_orderByClause` The clause of order-by.
`protected List<ENTITY>`	`_selectedList` The list of selected entity.
`protected String`	`_tableDbName` The DB name of table.

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ListResultBean()

コンストラクタ
コンストラクタと説明
`ListResultBean()`

メソッドのサマリー

All Methods Instance Methods Concrete Methods Deprecated Methods
修飾子とタイプ	メソッドと説明
`boolean`	`add(ENTITY o)`
`void`	`add(int index, ENTITY element)`
`boolean`	`addAll(Collection<? extends ENTITY> c)`
`boolean`	`addAll(int index, Collection<? extends ENTITY> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`protected Iterator<ENTITY>`	`createEmptyIterator()`
`protected <ELEMENT> ListResultBean<ELEMENT>`	`createInheritedResultBean(List<ELEMENT> selectedList)`
`boolean`	`equals(Object other)`
`<COLUMN> List<COLUMN>`	`extractColumnList(EntityColumnExtractor<ENTITY,COLUMN> entityLambda)` Extract the value list of the column specified in extractor.
`<COLUMN> Set<COLUMN>`	`extractColumnSet(EntityColumnExtractor<ENTITY,COLUMN> entityLambda)` Extract the value set of the column specified in extractor.
`ENTITY`	`get(int index)`
`int`	`getAllRecordCount()` Get the value of allRecordCount.
`OrderByClause`	`getOrderByClause()` 非推奨です。 don't use this
`List<ENTITY>`	`getSelectedList()` Get the value of selectedList.
`String`	`getTableDbName()` Get the value of tableDbName.
`List<ListResultBean<ENTITY>>`	`groupingList(GroupingListDeterminer<ENTITY> determiner)` Return grouping list (split the list per group).
`Map<String,ListResultBean<ENTITY>>`	`groupingMap(GroupingMapDeterminer<ENTITY> entityLambda)` Return grouping map (split the list per group key).
`int`	`hashCode()`
`protected boolean`	`hasWrappedListInstance()`
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`boolean`	`isSelectedResult()` Is this result by selected?
`Iterator<ENTITY>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<ENTITY>`	`listIterator()`
`ListIterator<ENTITY>`	`listIterator(int index)`
`<DTO> ListResultBean<DTO>`	`mappingList(EntityDtoMapper<ENTITY,DTO> entityLambda)` Map the entity list to the list of other object.
`protected <ELEMENT> ResultBeanBuilder<ELEMENT>`	`newResultBeanBuilder(String tableDbName)`
`ENTITY`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`ENTITY`	`set(int index, ENTITY element)`
`void`	`setAllRecordCount(int allRecordCount)` Set the value of allRecordCount.
`void`	`setOrderByClause(OrderByClause orderByClause)` Set the value of orderByClause.
`void`	`setSelectedList(List<ENTITY> selectedList)` Set the value of selectedList.
`void`	`setTableDbName(String tableDbName)` Set the value of tableDbName.
`int`	`size()`
`List<ENTITY>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<TYPE> TYPE[]`	`toArray(TYPE[] a)`
`String`	`toString()`

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

インタフェースから継承されたメソッド java.util.List
replaceAll, sort, spliterator

インタフェースから継承されたメソッド java.util.Collection
parallelStream, removeIf, stream

インタフェースから継承されたメソッド java.lang.Iterable
forEach

- フィールドの詳細
  - _tableDbName
```
protected String _tableDbName
```
    The DB name of table. (NullAllowed: if null, means not-selected-yet)
  - _allRecordCount
```
protected int _allRecordCount
```
    The count of all record.
  - _orderByClause
```
protected transient OrderByClause _orderByClause
```
    The clause of order-by. (NullAllowed: lazy-loaded)
  - _selectedList
```
protected List<ENTITY> _selectedList
```
    The list of selected entity. (NullAllowed: lazy-loaded)
- コンストラクタの詳細
  - ListResultBean
```
public ListResultBean()
```
- メソッドの詳細
  - mappingList
```
public <DTO> ListResultBean<DTO> mappingList(EntityDtoMapper<ENTITY,DTO> entityLambda)
```
    Map the entity list to the list of other object.
```
 ListResultBean<MemberWebBean> beanList = memberList.mappingList(member -> {
     MemberWebBean bean = new MemberWebBean();
     bean.setMemberId(member.getMemberId());
     bean.setMemberName(member.getMemberName());
     ...
     return bean;
 });
 
```
    This method needs the property 'selectedList' only.
    型パラメータ:
    
    DTO - The type of DTO.
    
    パラメータ:
    
    entityLambda - The callback for mapping of entity and DTO. (NotNull)
    
    戻り値:
    
    The new mapped list as result bean. (NotNull)
  - groupingList
```
public List<ListResultBean<ENTITY>> groupingList(GroupingListDeterminer<ENTITY> determiner)
```
    Return grouping list (split the list per group).
    This method needs the property 'selectedList' only.
```
 // e.g. grouping per three records
 List<ListResultBean<Member>> groupingList = memberList.groupingList(new GroupingListDeterminer<Member>() {
     public boolean isBreakRow(GroupingListRowResource<Member> rowResource, Member nextEntity) {
         return rowResource.getNextIndex() >= 3;
     }
 }, groupingOption);
 
 // e.g. grouping per initial character of MEMBER_NAME
 List<ListResultBean<Member>> groupingList = memberList.groupingList(new GroupingListDeterminer<Member>() {
     public boolean isBreakRow(GroupingListRowResource<Member> rowResource, Member nextEntity) {
         Member currentEntity = rowResource.getCurrentEntity();
         String currentInitChar = currentEntity.getMemberName().substring(0, 1);
         String nextInitChar = nextEntity.getMemberName().substring(0, 1);
         return !currentInitChar.equalsIgnoreCase(nextInitChar);
     }
 });
 
```
    パラメータ:
    
    determiner - The determiner of grouping list. (NotNull)
    
    戻り値:
    
    The grouping list that has grouped rows. (NotNull)
  - groupingMap
```
public Map<String,ListResultBean<ENTITY>> groupingMap(GroupingMapDeterminer<ENTITY> entityLambda)
```
    Return grouping map (split the list per group key).
    This method needs the property 'selectedList' only.
```
 // e.g. grouping per initial character of MEMBER_NAME
 Map<String, ListResultBean<Member>> groupingMap = memberList.groupingMap(member -> {
     return member.getMemberName().substring(0, 1);
 });
 
```
    パラメータ:
    
    entityLambda - The callback for determiner of grouping map. (NotNull)
    
    戻り値:
    
    The grouping map that has grouped rows, the key is provided. (NotNull)
  - extractColumnList
```
public <COLUMN> List<COLUMN> extractColumnList(EntityColumnExtractor<ENTITY,COLUMN> entityLambda)
```
    Extract the value list of the column specified in extractor.
```
 List<Integer> memberIdList = memberList.extractColumnList(member -> {
     return entity.getMemberId();
 });
 
```
    This method needs the property 'selectedList' only.
    型パラメータ:
    
    COLUMN - The type of COLUMN.
    
    パラメータ:
    
    entityLambda - The callback for value extractor of entity column. (NotNull)
    
    戻り値:
    
    The value list of the entity column. (NotNull, NotNullElement)
  - extractColumnSet
```
public <COLUMN> Set<COLUMN> extractColumnSet(EntityColumnExtractor<ENTITY,COLUMN> entityLambda)
```
    Extract the value set of the column specified in extractor.
```
 Set<Integer> memberIdList = memberList.extractColumnSet(member -> {
     return entity.getMemberId();
 });
 
```
    This method needs the property 'selectedList' only.
    型パラメータ:
    
    COLUMN - The type of COLUMN.
    
    パラメータ:
    
    entityLambda - The callback for value extractor of entity column. (NotNull)
    
    戻り値:
    
    The value set of the entity column. (NotNull, NotNullElement)
  - isSelectedResult
```
public boolean isSelectedResult()
```
    Is this result by selected?
    
    戻り値:
    
    The determination, true or false. {whether table DB name is not null}
  - createInheritedResultBean
```
protected <ELEMENT> ListResultBean<ELEMENT> createInheritedResultBean(List<ELEMENT> selectedList)
```
  - newResultBeanBuilder
```
protected <ELEMENT> ResultBeanBuilder<ELEMENT> newResultBeanBuilder(String tableDbName)
```
  - hashCode
```
public int hashCode()
```
    定義:
    
    hashCode インタフェース内 Collection<ENTITY>
    
    定義:
    
    hashCode インタフェース内 List<ENTITY>
    
    オーバーライド:
    
    hashCode クラス内 Object
    
    戻り値:
    
    Hash-code from primary-keys.
  - equals
```
public boolean equals(Object other)
```
    定義:
    
    equals インタフェース内 Collection<ENTITY>
    
    定義:
    
    equals インタフェース内 List<ENTITY>
    
    オーバーライド:
    
    equals クラス内 Object
    
    パラメータ:
    
    other - Other entity. (NullAllowed)
    
    戻り値:
    
    Comparing result. If other is null, returns false.
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
    
    戻り値:
    
    The view string of all attribute values. (NotNull)
  - add
```
public boolean add(ENTITY o)
```
    定義:
    
    add インタフェース内 Collection<ENTITY>
    
    定義:
    
    add インタフェース内 List<ENTITY>
  - addAll
```
public boolean addAll(Collection<? extends ENTITY> c)
```
    定義:
    
    addAll インタフェース内 Collection<ENTITY>
    
    定義:
    
    addAll インタフェース内 List<ENTITY>
  - clear
```
public void clear()
```
    定義:
    
    clear インタフェース内 Collection<ENTITY>
    
    定義:
    
    clear インタフェース内 List<ENTITY>
  - contains
```
public boolean contains(Object o)
```
    定義:
    
    contains インタフェース内 Collection<ENTITY>
    
    定義:
    
    contains インタフェース内 List<ENTITY>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    定義:
    
    containsAll インタフェース内 Collection<ENTITY>
    
    定義:
    
    containsAll インタフェース内 List<ENTITY>
  - isEmpty
```
public boolean isEmpty()
```
    定義:
    
    isEmpty インタフェース内 Collection<ENTITY>
    
    定義:
    
    isEmpty インタフェース内 List<ENTITY>
  - iterator
```
public Iterator<ENTITY> iterator()
```
    定義:
    
    iterator インタフェース内 Iterable<ENTITY>
    
    定義:
    
    iterator インタフェース内 Collection<ENTITY>
    
    定義:
    
    iterator インタフェース内 List<ENTITY>
  - createEmptyIterator
```
protected Iterator<ENTITY> createEmptyIterator()
```
  - remove
```
public boolean remove(Object o)
```
    定義:
    
    remove インタフェース内 Collection<ENTITY>
    
    定義:
    
    remove インタフェース内 List<ENTITY>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    定義:
    
    removeAll インタフェース内 Collection<ENTITY>
    
    定義:
    
    removeAll インタフェース内 List<ENTITY>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    定義:
    
    retainAll インタフェース内 Collection<ENTITY>
    
    定義:
    
    retainAll インタフェース内 List<ENTITY>
  - size
```
public int size()
```
    定義:
    
    size インタフェース内 Collection<ENTITY>
    
    定義:
    
    size インタフェース内 List<ENTITY>
  - toArray
```
public Object[] toArray()
```
    定義:
    
    toArray インタフェース内 Collection<ENTITY>
    
    定義:
    
    toArray インタフェース内 List<ENTITY>
  - toArray
```
public <TYPE> TYPE[] toArray(TYPE[] a)
```
    定義:
    
    toArray インタフェース内 Collection<ENTITY>
    
    定義:
    
    toArray インタフェース内 List<ENTITY>
  - add
```
public void add(int index,
                ENTITY element)
```
    定義:
    
    add インタフェース内 List<ENTITY>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends ENTITY> c)
```
    定義:
    
    addAll インタフェース内 List<ENTITY>
  - get
```
public ENTITY get(int index)
```
    定義:
    
    get インタフェース内 List<ENTITY>
  - indexOf
```
public int indexOf(Object o)
```
    定義:
    
    indexOf インタフェース内 List<ENTITY>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    定義:
    
    lastIndexOf インタフェース内 List<ENTITY>
  - listIterator
```
public ListIterator<ENTITY> listIterator()
```
    定義:
    
    listIterator インタフェース内 List<ENTITY>
  - listIterator
```
public ListIterator<ENTITY> listIterator(int index)
```
    定義:
    
    listIterator インタフェース内 List<ENTITY>
  - remove
```
public ENTITY remove(int index)
```
    定義:
    
    remove インタフェース内 List<ENTITY>
  - set
```
public ENTITY set(int index,
                  ENTITY element)
```
    定義:
    
    set インタフェース内 List<ENTITY>
  - subList
```
public List<ENTITY> subList(int fromIndex,
                            int toIndex)
```
    定義:
    
    subList インタフェース内 List<ENTITY>
  - getTableDbName
```
public String getTableDbName()
```
    Get the value of tableDbName.
    
    戻り値:
    
    The DB name of table. (NullAllowed: if null, it means not-selected-yet)
  - setTableDbName
```
public void setTableDbName(String tableDbName)
```
    Set the value of tableDbName.
    
    パラメータ:
    
    tableDbName - The DB name of table. (NotNull)
  - getAllRecordCount
```
public int getAllRecordCount()
```
    Get the value of allRecordCount.
    
    戻り値:
    
    The count of all records.
  - setAllRecordCount
```
public void setAllRecordCount(int allRecordCount)
```
    Set the value of allRecordCount.
    
    パラメータ:
    
    allRecordCount - The count of all records.
  - getOrderByClause
```
public OrderByClause getOrderByClause()
```
    非推奨です。 don't use this
    
    Get the value of orderByClause.
    
    戻り値:
    
    The value of orderByClause. (NotNull)
  - setOrderByClause
```
public void setOrderByClause(OrderByClause orderByClause)
```
    Set the value of orderByClause.
    
    パラメータ:
    
    orderByClause - The value of orderByClause. (NullAllowed)
  - getSelectedList
```
public List<ENTITY> getSelectedList()
```
    Get the value of selectedList.
    
    戻り値:
    
    Selected list. (NotNull)
  - setSelectedList
```
public void setSelectedList(List<ENTITY> selectedList)
```
    Set the value of selectedList.
    
    パラメータ:
    
    selectedList - Selected list. (NullAllowed: if null, clear the list)
  - hasWrappedListInstance
```
protected boolean hasWrappedListInstance()
```

クラス ListResultBean<ENTITY>

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

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

インタフェースから継承されたメソッド java.util.List

インタフェースから継承されたメソッド java.util.Collection

インタフェースから継承されたメソッド java.lang.Iterable

フィールドの詳細

_tableDbName

_allRecordCount

_orderByClause

_selectedList

コンストラクタの詳細

ListResultBean

メソッドの詳細

mappingList

groupingList

groupingMap

extractColumnList

extractColumnSet

isSelectedResult

createInheritedResultBean

newResultBeanBuilder

hashCode

equals

toString

add

addAll

clear

contains

containsAll

isEmpty

iterator

createEmptyIterator

remove

removeAll

retainAll

size

toArray

toArray

add

addAll

get

indexOf

lastIndexOf

listIterator

listIterator

remove

set

subList

getTableDbName

setTableDbName

getAllRecordCount

setAllRecordCount

getOrderByClause

setOrderByClause

getSelectedList

setSelectedList

hasWrappedListInstance