public class URLDCDefinition extends AbstractDefinition
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFINITIONS
Definition tag as the root.
|
static java.lang.String |
ID
ID for the individual Definition.
|
static java.lang.String |
IMPL_DEF
Implementation class for the individual Definition.
|
static java.lang.String |
URL_NS
Namespace for the metadata definition.
|
static java.lang.String |
USE_PERSIST_STRUCT |
CACHE_TO_SOURCEPATH, DONT_CACHE, mDCConfiguration, mFullName
TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE
Constructor and Description |
---|
URLDCDefinition() |
URLDCDefinition(java.lang.String name) |
Modifier and Type | Method and Description |
---|---|
void |
addDefinition(java.lang.String defName,
AbstractURLChildDefinition def)
Used to add a Definition to the URLDCDefinition aggregate map.
|
DataControl |
createDataControl()
Creates an instance of data control generated from the metadata definition.
|
java.lang.String |
getAdapterType()
Returns the type of the adapter.
|
java.util.Collection<AbstractURLChildDefinition> |
getAllChildDefinitions() |
java.lang.String |
getDCName()
Returns the name of the data control.
|
AbstractURLChildDefinition |
getDefinition(java.lang.String defName)
Returns a Definition based on the definition name.
|
org.w3c.dom.Node |
getMetadata()
Returns the element that defines the metadata for the data control.
|
java.lang.String |
getRootStructureName()
Gets the root structure definition name
|
StructureDefinition |
getStructure()
Gets the structure definition of the output data.
|
boolean |
isStructureDirty(boolean refresh)
Tells the framework whether the Data control structure is dirty and needs
to be refreshed on the palette.
|
void |
loadFromMetadata(org.w3c.dom.Node node,
java.util.Map params)
Loads the definition from a metadata
Node . |
void |
removeDefinition(java.lang.String defName)
Removes the Definition from the aggregate
|
void |
setRootStructureName(java.lang.String rootDefName)
Sets the root structure definition name
|
addParameter, assignDefaultPackage, createDuplicateDetailIterator, disableSharing, enableSharing, getAdapterContext, getCachingMode, getConfiguration, getConfigurationFullName, getDefClassName, getDefinitionParent, getDefinitionType, getFactoryClassName, getFullName, getJUDTDataControlName, getName, getParameter, getParameterCollection, getParameters, getProperties, getProperty, getRuntimeParameters, isSupported, removeParameter, setAdapterContext, setCachingMode, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, shouldCompileProjectOnCreate, useDefinitionProvider, usePersistedStructure
public static final java.lang.String URL_NS
public static final java.lang.String DEFINITIONS
public static final java.lang.String IMPL_DEF
public static final java.lang.String ID
public static final java.lang.String USE_PERSIST_STRUCT
public URLDCDefinition()
public URLDCDefinition(java.lang.String name)
public DataControl createDataControl()
AbstractDefinition
createDataControl
in class AbstractDefinition
public org.w3c.dom.Node getMetadata()
AbstractDefinition
getMetadata
in class AbstractDefinition
Node
that defines the metadata for this instance.
This metadata will be used at the runtime to fetch data from the
data source.public StructureDefinition getStructure()
AbstractDefinition
getStructure
in interface DataControlDefinition
getStructure
in class AbstractDefinition
public void loadFromMetadata(org.w3c.dom.Node node, java.util.Map params)
AbstractDefinition
Node
.loadFromMetadata
in class AbstractDefinition
node
- the metadata node. It can be null if no metadata is defined.params
- context parameters.public void addDefinition(java.lang.String defName, AbstractURLChildDefinition def)
defName
- def
- public AbstractURLChildDefinition getDefinition(java.lang.String defName)
defName
- public void removeDefinition(java.lang.String defName)
defName
- @Concealed public java.util.Collection<AbstractURLChildDefinition> getAllChildDefinitions()
public boolean isStructureDirty(boolean refresh)
isStructureDirty
in class AbstractDefinition
refresh
- flag to indicate if the refresh is requested for the
structure.public java.lang.String getAdapterType()
getAdapterType
in class AbstractDefinition
AdapterDefinition
public java.lang.String getRootStructureName()
getRootStructureName
in class AbstractDefinition
public java.lang.String getDCName()
AbstractDefinition
getDCName
in class AbstractDefinition
public void setRootStructureName(java.lang.String rootDefName)
setRootStructureName
in class AbstractDefinition