|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.data.JRCsvDataSourceProvider
public class JRCsvDataSourceProvider
Constructor Summary | |
---|---|
JRCsvDataSourceProvider(java.io.File file)
Builds a datasource instance. |
|
JRCsvDataSourceProvider(java.io.InputStream stream)
|
|
JRCsvDataSourceProvider(java.io.Reader reader)
Builds a datasource instance. |
Method Summary | |
---|---|
JRDataSource |
create(JasperReport report)
Creates and returns a new instance of the provided data source. |
void |
dispose(JRDataSource dataSource)
Disposes the data source previously obtained using the create method. |
java.lang.String[] |
getColumnNames()
|
java.text.DateFormat |
getDateFormat()
|
char |
getFieldDelimiter()
|
JRField[] |
getFields(JasperReport report)
Returns the fields that are available from the data source. |
java.text.NumberFormat |
getNumberFormat()
|
java.lang.String |
getRecordDelimiter()
|
void |
setColumnNames(java.lang.String[] colNames)
|
void |
setDateFormat(java.text.DateFormat dateFormat)
|
void |
setFieldDelimiter(char fieldDelimiter)
|
void |
setNumberFormat(java.text.NumberFormat numberFormat)
|
void |
setRecordDelimiter(java.lang.String recordDelimiter)
|
boolean |
supportsGetFieldsOperation()
Returns true if the provider supports the getFields
operation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JRCsvDataSourceProvider(java.io.InputStream stream)
stream
- an input stream containing CSV datapublic JRCsvDataSourceProvider(java.io.File file) throws java.io.FileNotFoundException
file
- a file containing CSV data
java.io.FileNotFoundException
public JRCsvDataSourceProvider(java.io.Reader reader)
reader
- a Reader instance, for reading the streamMethod Detail |
---|
public boolean supportsGetFieldsOperation()
JRDataSourceProvider
getFields
operation. By returning true in this method the data source provider indicates
that it is able to introspect the data source and discover the available fields.
supportsGetFieldsOperation
in interface JRDataSourceProvider
public JRField[] getFields(JasperReport report) throws JRException, java.lang.UnsupportedOperationException
JRDataSourceProvider
getFields
in interface JRDataSourceProvider
report
- the report that will be filled using the data source created by this provider.
The passed in report can be null. That means that no compiled report is available yet.
JRException
- if an error occurs.
java.lang.UnsupportedOperationException
- is the method is not supportedpublic JRDataSource create(JasperReport report) throws JRException
JRDataSourceProvider
create
in interface JRDataSourceProvider
report
- the report that will be filled using the created data source.
JRException
- if the data source creation has failedpublic void dispose(JRDataSource dataSource) throws JRException
JRDataSourceProvider
create
method.
This method must close any resources associated with the
data source. For instance the database connection should be
closed in case of the
JRResultSetDataSource
.
JRResultSetDataSource
a subclass of this data source can be created. This subclass will
hold the database connection and the prepared statement that were
used to obtain the ResultSet. On the time of the dispose these resources
can be retrieved from the data source object and closed.
dispose
in interface JRDataSourceProvider
dataSource
- the data source to dispose
JRException
- if the data source could not be disposedpublic java.lang.String[] getColumnNames()
public void setColumnNames(java.lang.String[] colNames)
public java.text.DateFormat getDateFormat()
public void setDateFormat(java.text.DateFormat dateFormat)
public char getFieldDelimiter()
public void setFieldDelimiter(char fieldDelimiter)
public java.lang.String getRecordDelimiter()
public void setRecordDelimiter(java.lang.String recordDelimiter)
public java.text.NumberFormat getNumberFormat()
public void setNumberFormat(java.text.NumberFormat numberFormat)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |