BlockExporter
| com.microstrategy.web.blocks.exporters.BlockExporter |
 Known Indirect Subclasses
|
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract Block |
exportBlock(ExporterContext context, String blockName, Object primaryObject)
Instead of exporting INTO a Block, this method exports a Block.
| ||||||||||
| abstract Block |
exportBlock(ExporterContext context, Object primaryObject)
Instead of exporting INTO a named Bloc, this exports into a Block defined
by the Exporter class.
| ||||||||||
| abstract void |
exportInto(ExporterContext context, BlockList blockList, Object primaryObject)
Instead of exporting into a BLOCK, this method exports the generated
Block into the supplied LIST.
| ||||||||||
| abstract void |
exportInto(ExporterContext context, Block rootBlock, Object primaryObject)
Export an object into a supplied Block instance.
| ||||||||||
| abstract BlockList |
exportList(ExporterContext context, Object primaryObject)
Instead of exporting into a supplied BlockList, this method simply creates
a new, empty BlockList and then calls
exportInto(ExporterContext, BlockList, Object). | ||||||||||
Public Methods
public abstract Block exportBlock (ExporterContext context, String blockName, Object primaryObject)
Instead of exporting INTO a Block, this method exports a Block. It is up to the
caller to determine what is done with it. This method creates a Block and then
calls exportInto(ExporterContext, Block, Object).
Parameters
| context | The ExporterContext object. |
|---|---|
| blockName | The name of the root block to create an instance for. |
| primaryObject | The primary object that we are export. |
Returns
- The Block created by the Exporter.
Throws
| Exception | If we are unable to create a Block instance. |
|---|
public abstract Block exportBlock (ExporterContext context, Object primaryObject)
Instead of exporting INTO a named Bloc, this exports into a Block defined
by the Exporter class. This method collects the root block defined by
Exporter and calls exportBlock(ExporterContext, String, Object).
Parameters
| context | The ExporterContext object. |
|---|---|
| primaryObject | The primary object that we are export. |
Returns
- The Block created by the Exporter.
Throws
| Exception | If we are unable to create a Block instance. |
|---|
public abstract void exportInto (ExporterContext context, BlockList blockList, Object primaryObject)
Instead of exporting into a BLOCK, this method exports the generated Block into the supplied LIST.
Parameters
| context | The ExporterContext object. |
|---|---|
| blockList | The BlockList to export INTO. |
| primaryObject | The primary object that we are export. |
Throws
| Exception | If we are unable to create a Block instance. |
|---|
public abstract void exportInto (ExporterContext context, Block rootBlock, Object primaryObject)
Export an object into a supplied Block instance. This is effectively the "lowest" level interface to exporting.
Parameters
| context | The ExporterContext object. |
|---|---|
| rootBlock | The root Block to export INTO. |
| primaryObject | The primary object that we are export. |
Throws
| Exception | If we are unable to create a Block instance. |
|---|
public abstract BlockList exportList (ExporterContext context, Object primaryObject)
Instead of exporting into a supplied BlockList, this method simply creates
a new, empty BlockList and then calls exportInto(ExporterContext, BlockList, Object).
The newly created BlockList is returned.
Parameters
| context | The ExporterContext object. |
|---|---|
| primaryObject | The primary object that we are export. |
Returns
- The BlockList created by the Exporter.
Throws
| Exception | If we are unable to create a Block instance. |
|---|