|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 2 (11.1.2.0.0) E17483-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.adf.model.adapter.dataformat.FormatHelper
public final class FormatHelper
Format structure handlers create structure from a source according to the jsr227 specification. This class will provide some common way to generate structure for some different use cases.
For some sources, e.g. a CSV data source, data is returned as a collection of rows. The structure definition must identify the returned collection as an Accessor so that the user can drop them on a view page from Data Control Palette. Moreover, the data control can be defined so that the definition depends on some parameters. For example CSV data control can define a URL source that takes a parameter, e.g. http://my.bugs?status=##STATUS##. The definition parameters should be exposed through the data control structure definition so that they can be bound to the page parameter etc. for a specific usage in a page.
This class supports method
to create
a virtual method wrapped over the structure definition returned by the data
control adapter. The virtual method exposes the definition parameters as the
method parameters. The data returned by the data control is then returned by
the method. So when an element under this method, which are exposed by the
data control adapter, is dropped on a page a MethodActionBinding is generated
and the parameter values can be set.
FormatHelper.StructureHelper.getRootMethod(StructureDefinition,boolean,DefinitionContext)
This class also supports method
to create a root accessor in case the data control definition is not
parameterized. The accesor creates all required binding paths required to be
created for the data structure.
FormatHelper.StructureHelper.getRootAccessor(StructureDefinition,boolean,DefinitionContext)
Nested Class Summary | |
---|---|
static class |
FormatHelper.DataHelper
Class that provides different helper methods for the data extracted from a format data handler. |
static class |
FormatHelper.StructureHelper
Class that provides different helper methods for the structure definition extracted from a format structure handler. |
Field Summary | |
---|---|
static java.lang.String |
ATTRIBUTE_UPDATEABLE
Is the Attribute updateable |
static java.lang.String |
DATA
Name of the collection returned by the wrapper method. |
static java.lang.String |
METHOD_CREATE
Name of the wrapper method that a structure definition can be wrapped with. |
static java.lang.String |
OPERATIONS
Name of the accessor to have the standard operations. |
Constructor Summary | |
---|---|
FormatHelper()
|
Method Summary | |
---|---|
static StructureDef |
createStandardCollectionOpStructure(NamedDefinition parent)
Adds standard set of methods for a colection. |
static FormatHelper.DataHelper |
getDataHelper(FormatDataHandler handler)
Gets the helper for a FormatDataHandler . |
static FormatHelper.StructureHelper |
getStructureHelper(FormatStructureHandler handler)
Gets the structure definition helper for a FormatStructureHandler . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String METHOD_CREATE
public static final java.lang.String DATA
public static final java.lang.String OPERATIONS
public static final java.lang.String ATTRIBUTE_UPDATEABLE
Constructor Detail |
---|
public FormatHelper()
Method Detail |
---|
public static final FormatHelper.StructureHelper getStructureHelper(FormatStructureHandler handler)
FormatStructureHandler
.
handler
- format structure handler that generates structure definition
from a specifc data source.public static final FormatHelper.DataHelper getDataHelper(FormatDataHandler handler)
FormatDataHandler
.
handler
- format data handler that extracts data from a specific data
source.public static StructureDef createStandardCollectionOpStructure(NamedDefinition parent)
parent
- parent structure definition.
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 2 (11.1.2.0.0) E17483-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |