InformationFragmentSource

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> k_int >> [ IR overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.k_int.IR
Interface InformationFragmentSource

public interface InformationFragmentSource

Field Summary

static RecordFormatSpecification default_spec
          It is *Essential* that the default_record_syntax and default_element_set_name properties are set by the Searchable init method for this part of the framework to hang together properly!

Method Summary

void asyncGetFragment(int starting_fragment, int count, RecordFormatSpecification spec, IFSNotificationTarget target)


void destroy()
          Release all resources and shut down the object

AsynchronousEnumeration elements()
          Enumerate all the items availabe from this fragment source

InformationFragment[] getFragment(int starting_fragment, int count, RecordFormatSpecification spec)
          Position based range access to the result set.

int getFragmentCount()
          Current number of fragments available

IRStatusReport getStatusReport()
          If this source aggregates other sources, there status reports can be found here, return null if this is an original source of data.

Field Detail

default_spec

public static final RecordFormatSpecification default_spec

It is *Essential* that the default_record_syntax and default_element_set_name properties are set by the Searchable init method for this part of the framework to hang together properly!

Method Detail

getFragment

public InformationFragment[] getFragment(int starting_fragment,
                                         int count,
                                         RecordFormatSpecification spec)
                                  throws PresentException

Position based range access to the result set. Implementation must be 1 based: IE, First record in result set is 1 not 0. Local mappings (e.g to vector) must account for this!

asyncGetFragment

public void asyncGetFragment(int starting_fragment,
                             int count,
                             RecordFormatSpecification spec,
                             IFSNotificationTarget target)

getFragmentCount

public int getFragmentCount()

Current number of fragments available

elements

public AsynchronousEnumeration elements()

Enumerate all the items availabe from this fragment source

destroy

public void destroy()

Release all resources and shut down the object

getStatusReport

public IRStatusReport getStatusReport()

If this source aggregates other sources, there status reports can be found here, return null if this is an original source of data.