jet.datastream

Interface Communicator

All Superinterfaces:

java.awt.print.Pageable

Deprecated.

@Deprecated
public interface Communicator
extends java.awt.print.Pageable

The Communicator interface is designed for Logi Report Engine inner usage, we did not design it for Customer's usage, we strongly recommend that customers do not use it. This interface and it's methods "which previously were exposed in api doc" will be recorded as Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIND_FROM_CURPAGE Deprecated.
static java.lang.String	getDataStream Deprecated.
static java.lang.String	getDbBuffer Deprecated.
static java.lang.String	getHeaderInfo Deprecated.
static java.lang.String	getIndexColumn Deprecated.
static java.lang.String	getIndexPages Deprecated.
static java.lang.String	getPage Deprecated.
static java.lang.String	getPageNum Deprecated.
static java.lang.String	getRecordBlock Deprecated.
static java.lang.String	getSubIdx Deprecated.
static java.lang.String	getTemplates Deprecated.
static java.lang.String	isEngineFinished Deprecated.

Fields inherited from interface java.awt.print.Pageable

UNKNOWN_NUMBER_OF_PAGES

Method Summary

Modifier and Type	Method and Description
boolean	chartInDirtyPages(int pageNum) Deprecated.
void	clearMem() Deprecated.
FindResult	findNext(java.lang.String text, int begPage, boolean matchWholeWord, boolean matchCase) Deprecated.
FindResult	findPrev(java.lang.String text, int begPage, boolean matchWholeWord, boolean matchCase) Deprecated.
DSLeafGroup[][]	getAllGroupBranch(int subidx) Deprecated.
java.io.InputStream	getBlob(int subidx, int blobidx, long entry) Deprecated.
JFieldValueNLSManager	getCatalogNlsManager(int subIdx) Deprecated. Get catalog level {link JFieldValueNLSManager} which current main report or subReport running
java.lang.String	getCatalogNlsPrefix(java.lang.String key) Deprecated. get catalog Nls datamapping file name by dbfield involved key or chart combination key
java.util.List<java.lang.String>	getCatalogNlsPrefixList(java.lang.String key) Deprecated. get catalog Nls datamapping file name list by OnScreenFilter involved key
java.util.Hashtable	getChartSummaryInfo(int subIdx, int templateIdx) Deprecated.
RandomInputable	getContent() Deprecated.
java.util.Locale	getCustomLocale(java.lang.String formatLocale) Deprecated. Get customize Locale
java.util.TimeZone	getCustomTimeZone(int offsetMillis) Deprecated. Get customize timezone of GMT (such as GMT+08:00)
DSDataStreamable	getDataStream(DSDataStreamable ds, int branchIdx) Deprecated.
DSDataStreamable	getDataStream(int subidx) Deprecated.
JDbBufferCursor	getDbBuffer(int subidx) Deprecated.
DirtyFieldInParagraphManager	getDirtyFieldInParagraphLayoutManager() Deprecated.
DSPage	getDrillDownPage(int subidx, int pageIdx, int recordIdx, short templateIndex, int branchIdx) Deprecated.
DSPage	getDrillDownPage(int subidx, int pageIdx, int recordIdx, short templateIndex, int branchIdx, int drillSecType, java.lang.String largeGrpValue, java.lang.String smallGrpValue) Deprecated.
DSPage	getDrillDownPage(int subidx, int pageIdx, int recordIdx, short templateIndex, int branchIdx, int drillSecType, java.lang.String largeGrpValue, java.lang.String smallGrpValue, JRObjectResult obj) Deprecated.
DSPage	getDrillDownPage(int subidx, int pageIdx, int recordIdx, short templateIndex, int branchIdx, JRObjectResult obj) Deprecated.
DSTOC	getDSTOC() Deprecated.
java.lang.String	getEncoding() Deprecated.
ExportTimeInfo	getExportTimeInfo() Deprecated.
java.util.TimeZone	getExportTimeZone() Deprecated.
DSPage	getFastPassPage(int pnum) Deprecated.
JFieldValueNLSManager	getFieldNLSManager() Deprecated.
JFieldValueNLSManager	getFiledNlsManager(int subIdx) Deprecated. Get {link JFieldValueNLSManager} which current main report or subReport running
JDbBufferData[]	getFilterControlValueList(DSTemplatible template, java.lang.String columnName, int subIndex) Deprecated.
java.util.Hashtable	getFldSummaryInfo(int subIdx, int templateIdx) Deprecated.
int	getFromEncoding() Deprecated.
DSLeafGroup	getGroupBranch(int subidx, int leafidx) Deprecated.
ReportHeaderInfo	getHeaderInfo(int subidx) Deprecated.
ImgInfo	getImgInfoInMainRpt() Deprecated. get ImgInfo in main report, which is only for DSObject of main report to get it when exporting time
java.io.InputStream	getIndexColumn(DbColDesc coldesc) Deprecated.
java.io.InputStream	getIndexColumn(int colIndex) Deprecated.
java.io.InputStream	getIndexPages(DbValue value) Deprecated.
INLSMap	getINLSMap(int subIndex) Deprecated. for condition format apply fontface-fontsize mapping at export time
java.util.Hashtable<java.lang.Integer,INLSMap>	getINLSMaps() Deprecated. for condition format apply fontface-fontsize mapping at export time
java.util.Vector	getLeafGroupIndexes(int subidx) Deprecated.
java.util.Vector	getLinkComms() Deprecated.
Communicator	getLinkedComm(int idx) Deprecated.
java.lang.String	getLinkedInfo(int keyIdx) Deprecated.
int	getLinkedPage(int keyIdx) Deprecated.
java.util.List	getListRunTimeInfo(int subIdx, java.lang.String templateName) Deprecated.
java.util.Locale	getLocale() Deprecated.
int	getModeType() Deprecated.
DSPage	getPage(int pnum) Deprecated.
PageACL	getPageACL() Deprecated.
int	getPageNum() Deprecated.
java.util.Hashtable	getParameterBuffer() Deprecated.
java.util.Hashtable	getparamsSting() Deprecated.
int	getPhysicalTotalPageNum() Deprecated.
PLSInfo	getPLSInfo() Deprecated. If it is not communicator with Page level security, it will return null
java.io.InputStream	getRecordBlock(int recordNum, int subidx) Deprecated.
int	getResolution() Deprecated.
int	getStartPageNumOfContentPages() Deprecated. Get start page number for exhibition content pages in current communicator, from 17522-TocPage enhancement
int	getSubIdx(DSTemplatible template) Deprecated.
short	getSubIdxOfRpt(short subIdxOfComp) Deprecated. Get subIdx of report(main report or subReport) which component lie in based subIdx of component For productEngine usage scenario, we take other logic to get same target, so need not it now,can be fake implementation now , such as return -1 always.
java.util.Hashtable	getTemplates(int subidx) Deprecated.
java.util.TimeZone	getTimeZone() Deprecated.
TocInfo	getTocInfo() Deprecated.
int	getToEncoding() Deprecated.
int	getTotalPageNumber(int dsIndex) Deprecated.
int	getTotalRecordsOfQuery(int queryID, boolean totalOrFetch) Deprecated.
void	initFonts() Deprecated.
boolean	isBeStopping() Deprecated.
boolean	isContinuousPageNumberWithTocPage() Deprecated.
boolean	isEngineFinished() Deprecated.
boolean	isFastPass() Deprecated.
boolean	isFinish() Deprecated.
boolean	isHighPrecision() Deprecated.
boolean	isMain(int subIdx) Deprecated.
boolean	isPreDefinedCol() Deprecated.
void	makeChartDataset(int subIdx, DSChartDataset set) Deprecated.
void	makeChartStringValue(DSChartDataset set) Deprecated.
DSTemplatible	popHTMLParsedJetObject(java.lang.String key) Deprecated. Convert HTML Tag, FS179768 DHTML need JetObject after 4 page write and read.
void	pushHTMLParsedJetObject(java.lang.String key, DSTemplatible jetObj) Deprecated. v15.6 Convert HTML Tag, FS179768 DHTML need JetObject after 4 page write and read.
void	setBeStopping(boolean beStopping) Deprecated.
void	setDirtyFieldInParagraphLayoutManager(DirtyFieldInParagraphManager manager) Deprecated.
void	setPreDefinedCol(boolean isPreDefinedCol) Deprecated.
void	setResolution(int res) Deprecated.
int	sizeOfRecord(int subIdx) Deprecated.
boolean	totalRecordsNull() Deprecated.
void	waitFinished() Deprecated.

Methods inherited from interface java.awt.print.Pageable

getNumberOfPages, getPageFormat, getPrintable

Field Detail

getHeaderInfo

static final java.lang.String getHeaderInfo

Deprecated.

See Also:

Constant Field Values

getTemplates

static final java.lang.String getTemplates

Deprecated.

See Also:

Constant Field Values

getDbBuffer

static final java.lang.String getDbBuffer

Deprecated.

See Also:

Constant Field Values

getDataStream

static final java.lang.String getDataStream

Deprecated.

See Also:

Constant Field Values

getPage

static final java.lang.String getPage

Deprecated.

See Also:

Constant Field Values

getRecordBlock

static final java.lang.String getRecordBlock

Deprecated.

See Also:

Constant Field Values

getIndexColumn

static final java.lang.String getIndexColumn

Deprecated.

See Also:

Constant Field Values

getIndexPages

static final java.lang.String getIndexPages

Deprecated.

See Also:

Constant Field Values

getPageNum

static final java.lang.String getPageNum

Deprecated.

See Also:

Constant Field Values

isEngineFinished

static final java.lang.String isEngineFinished

Deprecated.

See Also:

Constant Field Values

getSubIdx

static final java.lang.String getSubIdx

Deprecated.

See Also:

Constant Field Values

FIND_FROM_CURPAGE

static final int FIND_FROM_CURPAGE

Deprecated.

See Also:

Constant Field Values

Method Detail

getHeaderInfo

@Deprecated
ReportHeaderInfo getHeaderInfo(int subidx)

Deprecated.

getTemplates

@Deprecated
java.util.Hashtable getTemplates(int subidx)

Deprecated.

getDbBuffer

@Deprecated
JDbBufferCursor getDbBuffer(int subidx)

Deprecated.

getDataStream

DSDataStreamable getDataStream(int subidx)
                        throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getDataStream

DSDataStreamable getDataStream(DSDataStreamable ds,
                               int branchIdx)

Deprecated.

getPage

@Deprecated
DSPage getPage(int pnum)
                    throws JRStopEngineException

Deprecated.

Returns specified DSPage which involved to specific page number

Parameters:

pnum - page number based which we get specified DSPage

Returns:

DSPage which involved to specific page number

Throws:

JRStopEngineException - if receive stop order from outside

getRecordBlock

@Deprecated
java.io.InputStream getRecordBlock(int recordNum,
                                               int subidx)

Deprecated.

getIndexColumn

@Deprecated
java.io.InputStream getIndexColumn(DbColDesc coldesc)

Deprecated.

getIndexColumn

@Deprecated
java.io.InputStream getIndexColumn(int colIndex)

Deprecated.

getIndexPages

@Deprecated
java.io.InputStream getIndexPages(DbValue value)

Deprecated.

getPageNum

@Deprecated
int getPageNum()

Deprecated.

Get total page number

Returns:

total page number

isEngineFinished

@Deprecated
boolean isEngineFinished()

Deprecated.

Returns true If the report engine "which is involved to this Communicator Object" is finished.

Returns:

true if the report engine "which is involved to this Communicator Object" is finished.

getSubIdx

@Deprecated
int getSubIdx(DSTemplatible template)

Deprecated.

getGroupBranch

@Deprecated
DSLeafGroup getGroupBranch(int subidx,
                                       int leafidx)

Deprecated.

getAllGroupBranch

@Deprecated
DSLeafGroup[][] getAllGroupBranch(int subidx)

Deprecated.

getLeafGroupIndexes

@Deprecated
java.util.Vector getLeafGroupIndexes(int subidx)

Deprecated.

getDrillDownPage

@Deprecated
DSPage getDrillDownPage(int subidx,
                                    int pageIdx,
                                    int recordIdx,
                                    short templateIndex,
                                    int branchIdx)
                             throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getDrillDownPage

@Deprecated
DSPage getDrillDownPage(int subidx,
                                    int pageIdx,
                                    int recordIdx,
                                    short templateIndex,
                                    int branchIdx,
                                    JRObjectResult obj)
                             throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getDrillDownPage

@Deprecated
DSPage getDrillDownPage(int subidx,
                                    int pageIdx,
                                    int recordIdx,
                                    short templateIndex,
                                    int branchIdx,
                                    int drillSecType,
                                    java.lang.String largeGrpValue,
                                    java.lang.String smallGrpValue)
                             throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getDrillDownPage

@Deprecated
DSPage getDrillDownPage(int subidx,
                                    int pageIdx,
                                    int recordIdx,
                                    short templateIndex,
                                    int branchIdx,
                                    int drillSecType,
                                    java.lang.String largeGrpValue,
                                    java.lang.String smallGrpValue,
                                    JRObjectResult obj)
                             throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getBlob

@Deprecated
java.io.InputStream getBlob(int subidx,
                                        int blobidx,
                                        long entry)

Deprecated.

findNext

@Deprecated
FindResult findNext(java.lang.String text,
                                int begPage,
                                boolean matchWholeWord,
                                boolean matchCase)
                         throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

findPrev

@Deprecated
FindResult findPrev(java.lang.String text,
                                int begPage,
                                boolean matchWholeWord,
                                boolean matchCase)

Deprecated.

clearMem

@Deprecated
void clearMem()

Deprecated.

For remove resource that used in Communicator implemention.

getContent

@Deprecated
RandomInputable getContent()

Deprecated.

Get report as a RandomInputable.

setResolution

@Deprecated
void setResolution(int res)

Deprecated.

Set the Resolution of the printer.

Parameters:

res - Resolution value which you want to set

getResolution

@Deprecated
int getResolution()

Deprecated.

Get the Resolution of the printer.

Returns:

the Resolution value

initFonts

@Deprecated
void initFonts()
                    throws java.io.IOException

Deprecated.

Init the true type fonts, if there are any.

Throws:

java.io.IOException - if encounter IO error when load font file.

makeChartDataset

void makeChartDataset(int subIdx,
                      DSChartDataset set)

Deprecated.

sizeOfRecord

int sizeOfRecord(int subIdx)

Deprecated.

getLinkedComm

@Deprecated
Communicator getLinkedComm(int idx)

Deprecated.

getLinkedPage

int getLinkedPage(int keyIdx)
           throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getLinkedInfo

java.lang.String getLinkedInfo(int keyIdx)

Deprecated.

getPhysicalTotalPageNum

@Deprecated
int getPhysicalTotalPageNum()

Deprecated.

If there are linked com inside, return the total page number plus the linked report.

Returns:

the total page number plus the linked report.

getLocale

@Deprecated
java.util.Locale getLocale()

Deprecated.

Gets current {link Locale}. For supporting NLS

Returns:

current Locale

getEncoding

@Deprecated
java.lang.String getEncoding()

Deprecated.

Gets current encoding. For supporting NLS.

Returns:

current encoding

getTimeZone

@Deprecated
java.util.TimeZone getTimeZone()

Deprecated.

Gets current {link TimeZone}. For support NLS.

Returns:

current TimeZone

getExportTimeZone

@Deprecated
java.util.TimeZone getExportTimeZone()

Deprecated.

Gets export timeZone {link TimeZone}. For patch68057, with different timeZone from different dbvalue. For keep only use one export timeZone instance(for different export field, only set timeZone offset if necessary), and not affect original engine timeZone, if no meaningful timeZone offset from dbvalue, still use original engine timezone, so need keep original TimeZone. and protect it from multiple thread using original engine timezone.

Returns:

current EXport TimeZone

getCustomTimeZone

java.util.TimeZone getCustomTimeZone(int offsetMillis)

Deprecated.

Get customize timezone of GMT (such as GMT+08:00)

Parameters:

offsetMillis -

Returns:

customize timezone of GMT

isPreDefinedCol

boolean isPreDefinedCol()

Deprecated.

setPreDefinedCol

void setPreDefinedCol(boolean isPreDefinedCol)

Deprecated.

isFastPass

boolean isFastPass()

Deprecated.

getFastPassPage

DSPage getFastPassPage(int pnum)
                throws JRStopEngineException

Deprecated.

Throws:

JRStopEngineException

getLinkComms

java.util.Vector getLinkComms()

Deprecated.

isMain

boolean isMain(int subIdx)

Deprecated.

getDSTOC

DSTOC getDSTOC()

Deprecated.

getParameterBuffer

java.util.Hashtable getParameterBuffer()

Deprecated.

isBeStopping

boolean isBeStopping()

Deprecated.

setBeStopping

void setBeStopping(boolean beStopping)

Deprecated.

getFieldNLSManager

JFieldValueNLSManager getFieldNLSManager()

Deprecated.

getDirtyFieldInParagraphLayoutManager

DirtyFieldInParagraphManager getDirtyFieldInParagraphLayoutManager()

Deprecated.

setDirtyFieldInParagraphLayoutManager

void setDirtyFieldInParagraphLayoutManager(DirtyFieldInParagraphManager manager)

Deprecated.

isHighPrecision

boolean isHighPrecision()

Deprecated.

getFromEncoding

int getFromEncoding()

Deprecated.

getToEncoding

int getToEncoding()

Deprecated.

getTotalRecordsOfQuery

int getTotalRecordsOfQuery(int queryID,
                           boolean totalOrFetch)

Deprecated.

totalRecordsNull

boolean totalRecordsNull()

Deprecated.

getTotalPageNumber

int getTotalPageNumber(int dsIndex)

Deprecated.

getparamsSting

java.util.Hashtable getparamsSting()

Deprecated.

isFinish

boolean isFinish()

Deprecated.

getFldSummaryInfo

java.util.Hashtable getFldSummaryInfo(int subIdx,
                                      int templateIdx)

Deprecated.

getChartSummaryInfo

java.util.Hashtable getChartSummaryInfo(int subIdx,
                                        int templateIdx)

Deprecated.

chartInDirtyPages

boolean chartInDirtyPages(int pageNum)

Deprecated.

waitFinished

void waitFinished()

Deprecated.

makeChartStringValue

void makeChartStringValue(DSChartDataset set)

Deprecated.

getPageACL

PageACL getPageACL()

Deprecated.

getListRunTimeInfo

java.util.List getListRunTimeInfo(int subIdx,
                                  java.lang.String templateName)

Deprecated.

getFilterControlValueList

JDbBufferData[] getFilterControlValueList(DSTemplatible template,
                                          java.lang.String columnName,
                                          int subIndex)

Deprecated.

getExportTimeInfo

ExportTimeInfo getExportTimeInfo()

Deprecated.

getImgInfoInMainRpt

ImgInfo getImgInfoInMainRpt()

Deprecated.

get ImgInfo in main report, which is only for DSObject of main report to get it when exporting time

Returns:

ImgInfo

getFiledNlsManager

JFieldValueNLSManager getFiledNlsManager(int subIdx)

Deprecated.

Get {link JFieldValueNLSManager} which current main report or subReport running

Parameters:

subIdx, - subIdx of subReport or mainReport which is defined in layouttime

Returns:

{link JFieldValueNLSManager} which current report or subReport running

getCatalogNlsManager

JFieldValueNLSManager getCatalogNlsManager(int subIdx)

Deprecated.

Get catalog level {link JFieldValueNLSManager} which current main report or subReport running

Parameters:

subIdx, - subIdx of subReport or mainReport which is defined in layouttime

Returns:

catalog level {link JFieldValueNLSManager} which current report or subReport running

getCatalogNlsPrefix

java.lang.String getCatalogNlsPrefix(java.lang.String key)

Deprecated.

get catalog Nls datamapping file name by dbfield involved key or chart combination key

Parameters:

key, - dbfield involved key or chart combination key

Returns:

catalog Nls datamapping file name

getCatalogNlsPrefixList

java.util.List<java.lang.String> getCatalogNlsPrefixList(java.lang.String key)

Deprecated.

get catalog Nls datamapping file name list by OnScreenFilter involved key

Parameters:

key, - OnScreenFilter involved key

Returns:

catalog Nls datamapping file name list about this OnScreenFilter

getINLSMaps

java.util.Hashtable<java.lang.Integer,INLSMap> getINLSMaps()

Deprecated.

for condition format apply fontface-fontsize mapping at export time

Returns:

getINLSMap

INLSMap getINLSMap(int subIndex)

Deprecated.

for condition format apply fontface-fontsize mapping at export time

Returns:

getSubIdxOfRpt

short getSubIdxOfRpt(short subIdxOfComp)

Deprecated.

Get subIdx of report(main report or subReport) which component lie in based subIdx of component For productEngine usage scenario, we take other logic to get same target, so need not it now,can be fake implementation now , such as return -1 always. But for webView component layout scenario, we must implement this method.

Parameters:

subIdxOfComp -

Returns:

-1 if error, else it should be positive value

popHTMLParsedJetObject

DSTemplatible popHTMLParsedJetObject(java.lang.String key)

Deprecated.

Convert HTML Tag, FS179768 DHTML need JetObject after 4 page write and read. Store HTML Parsed template (jetObject). olny JCommunicator need implement this logic .

pushHTMLParsedJetObject

void pushHTMLParsedJetObject(java.lang.String key,
                             DSTemplatible jetObj)

Deprecated.

v15.6 Convert HTML Tag, FS179768 DHTML need JetObject after 4 page write and read. Get HTML Parsed template (jetObject). olny JCommunicator need implement this logic .

getModeType

int getModeType()

Deprecated.

getCustomLocale

java.util.Locale getCustomLocale(java.lang.String formatLocale)

Deprecated.

Get customize Locale

Parameters:

formatLocale -

Returns:

customize Locale

getTocInfo

TocInfo getTocInfo()

Deprecated.

getPLSInfo

PLSInfo getPLSInfo()

Deprecated.

If it is not communicator with Page level security, it will return null

Returns:

PLSInfo if it is communicator with Page level security(such as pageFilter) , else return null

getStartPageNumOfContentPages

int getStartPageNumOfContentPages()

Deprecated.

Get start page number for exhibition content pages in current communicator, from 17522-TocPage enhancement

Returns:

start page number for exhibition content pages

isContinuousPageNumberWithTocPage

boolean isContinuousPageNumberWithTocPage()

Deprecated.