public class XMLDCDef extends AbstractURLChildDefinition
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONNECTION_NAME
Attribute to hold the connection name.
|
static java.lang.String |
DEFINITION
Definition tag as the root.
|
static java.lang.String |
ENSURE_KEY_ATTRIBUTE |
static java.lang.String |
HTTP_HEADERS
HttpHeaders Element, describes the custom Http Headers.
|
static java.lang.String |
HTTP_METHOD
Attribute to hold the HTTP Method.
|
static java.lang.String |
ID
Attribute to hold the ID.
|
static java.lang.String |
IMPL_DEF
Attribute to hold the ImplDef.
|
static java.lang.String |
INPUT_SCHEMA_LOC
Attribute to contain the input XSD URL
|
static java.lang.String |
PARAM_NAME
HttpHeaders ParamName attribute
|
static java.lang.String |
PARAMETER
Parameter tag
|
static java.lang.String |
PARAMETER_NAME
Parameter name tag
|
static java.lang.String |
PARAMETER_VALUE
Parameter Value tag
|
static java.lang.String |
PARAMETERS
Parameters tag
|
static java.lang.String |
SCHEMA_LOC
Attribute to contain the XSD URL.
|
static java.lang.String |
SOURCE_LOC
Attribute to contain the source URL.
|
static java.lang.String |
TRANSFORMER_LOC
Attribute to contain the XSL URL.
|
static java.lang.String |
URL_QUERY
Attribute to hold the URL query.
|
static java.lang.String |
URLXML_NS
Namespace for the metadata definition.
|
static java.lang.String |
USE_PERSIST_STRUCT |
static java.lang.String |
XML_ROOT_ELEMENT
Attribute to hold root element
|
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 |
---|
XMLDCDef()
Default constructor.
|
XMLDCDef(java.lang.String name,
java.lang.String xsdLoc,
java.lang.String xslLoc)
Creats a URL XML Definition object.
|
Modifier and Type | Method and Description |
---|---|
void |
bindConnection(javax.naming.Context context,
javax.naming.Reference conn)
Bind the underlying connection used by this data control into the
context provided by the caller.
|
DataControl |
createDataControl()
Creates XML data control instance from the metadata definition.
|
java.lang.String |
getAdapterType()
Returns the type of the adapter.
|
java.lang.String |
getConnectionName()
return the URL connection name.
|
java.lang.String |
getDataControlImplName()
Gets the name of the data control implementation class for URL XML.
|
java.lang.String |
getDCName()
return name of the data control
|
java.lang.String |
getHttpHeaderParamName() |
java.lang.String |
getHttpMethod()
return the Http Method.
|
java.lang.String |
getID() |
java.lang.String |
getInputXSDLoc()
return the Input XSD Location.
|
org.w3c.dom.Node |
getMetadata()
Returns the metadata definition node.
|
MethodDef |
getMethodDef(StructureDef structDef,
AdapterContext adapterCtx,
java.lang.String dcName)
Added to the child definitions for Backward Compatibility.
|
java.util.Map |
getParamsMap()
Returns a mapping of the parameters and the default values.
|
java.lang.String |
getRootElement()
return the Url query.
|
java.lang.String |
getRootStructureName()
Gets the root structure definition name
|
java.lang.String |
getSourceLocation()
return the data source location.
|
StructureDefinition |
getStructure()
Returns the structure definition.
|
java.lang.String |
getUrlQuery()
return the Url query.
|
java.lang.String |
getXSDLocation()
return the XSD location.
|
java.lang.String |
getXSLLocation()
return the XSL location.
|
boolean |
isIncludeHttpHeaders() |
boolean |
isStructureDirty(boolean refresh)
Tells the framework whether the Data control structure is dirty and needs
to be refreshed on the palette.
|
void |
loadDefinition(org.w3c.dom.Node node,
java.util.Map params)
Added to the child definitions for Backward Compatibility.
|
void |
loadFromMetadata(org.w3c.dom.Node node,
java.util.Map params)
Loads the definition from a metadata
Node . |
void |
setCachingMode(int cachingMode) |
void |
setEnsureKeyAttribute(boolean ensureKeyAttribute)
Deprecated.
|
void |
setEnsureStructureV2(boolean ensureStructureV2)
Deprecated.
|
void |
setHttpHeaderParamName(java.lang.String mHttpHeaderParamName) |
void |
setHttpMethod(java.lang.String methodName)
Sets the Http Method for the definition.
|
void |
setID(java.lang.String id) |
void |
setIncludeHttpHeaders(boolean mIncludeHttpHeaders) |
void |
setInputXSDLoc(java.lang.String XSDLoc)
Sets the Input XSD Location.
|
void |
setParamsMap(java.util.Map paramsMap)
Sets the parameter Maps for the definition.
|
void |
setRootElement(java.lang.String rootElement)
set the RootElement.
|
void |
setRootStructureName(java.lang.String rootDefName)
Sets the root structure definition name
|
void |
setSourceConnectionName(java.lang.String name)
Sets the name of the URL connection of the data source.
|
void |
setSourceLocation(java.lang.String loc)
Sets the data source location.
|
void |
setUrlQuery(java.lang.String query)
Sets the query of the data source.
|
void |
setXSDLocation(java.lang.String xsdLoc)
set the XSD location.
|
void |
setXSLLocation(java.lang.String xslLoc)
set the XSL location.
|
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, setCompileProjectOnCreate, setConfigurationFullName, setFullName, setName, setProperty, shouldCompileProjectOnCreate, useDefinitionProvider, usePersistedStructure
public static final java.lang.String URLXML_NS
public static final java.lang.String DEFINITION
public static final java.lang.String SOURCE_LOC
public static final java.lang.String CONNECTION_NAME
public static final java.lang.String URL_QUERY
public static final java.lang.String HTTP_METHOD
public static final java.lang.String ID
public static final java.lang.String IMPL_DEF
public static final java.lang.String SCHEMA_LOC
public static final java.lang.String TRANSFORMER_LOC
public static final java.lang.String USE_PERSIST_STRUCT
public static final java.lang.String INPUT_SCHEMA_LOC
public static final java.lang.String XML_ROOT_ELEMENT
public static final java.lang.String PARAMETERS
public static final java.lang.String PARAMETER
public static final java.lang.String PARAMETER_NAME
public static final java.lang.String PARAMETER_VALUE
public static final java.lang.String HTTP_HEADERS
public static final java.lang.String PARAM_NAME
public static final java.lang.String ENSURE_KEY_ATTRIBUTE
public XMLDCDef()
public XMLDCDef(java.lang.String name, java.lang.String xsdLoc, java.lang.String xslLoc)
name
- Name of the definition.xsdLoc
- XML XSD Location.xslLoc
- XML XSL location.public java.lang.String getDCName()
getDCName
in class AbstractDefinition
public java.lang.String getDataControlImplName()
public void setSourceLocation(java.lang.String loc) throws AdapterException
If the source connection name is defined, the source location value will not be used to fetch data.
loc
- Location of the data source.AdapterException
public void bindConnection(javax.naming.Context context, javax.naming.Reference conn) throws AdapterException
context
- The Context
provided by the caller into which
the connection for this service is to be bound.{@link
- AdapterException} If the connection cannot be bound into
the context provided.AdapterException
public void setSourceConnectionName(java.lang.String name)
name
- Name of the connection that is used as the data source.public void setUrlQuery(java.lang.String query)
query
- of the data source.public void setParamsMap(java.util.Map paramsMap)
public java.util.Map getParamsMap()
param1
and MyFile
are the parameters to the data control method.public void setHttpMethod(java.lang.String methodName)
methodName
- Http Method to be invokedpublic void setInputXSDLoc(java.lang.String XSDLoc)
XSDLoc
- Input XSD URLpublic org.w3c.dom.Node getMetadata()
getMetadata
in class AbstractDefinition
public StructureDefinition getStructure()
getStructure
in interface DataControlDefinition
getStructure
in class AbstractDefinition
public void loadFromMetadata(org.w3c.dom.Node node, java.util.Map params)
Node
.loadFromMetadata
in class AbstractDefinition
node
- the metadata node.params
- context parameters.public DataControl createDataControl()
createDataControl
in class AbstractDefinition
public java.lang.String getSourceLocation()
public java.lang.String getXSDLocation()
public void setXSDLocation(java.lang.String xsdLoc)
public void setXSLLocation(java.lang.String xslLoc)
public void setRootElement(java.lang.String rootElement)
public java.lang.String getXSLLocation()
public java.lang.String getConnectionName()
getConnectionName
in class AbstractURLChildDefinition
public java.lang.String getUrlQuery()
public java.lang.String getHttpMethod()
public java.lang.String getInputXSDLoc()
public java.lang.String getRootElement()
public java.lang.String getAdapterType()
getAdapterType
in class AbstractDefinition
AdapterDefinition
public boolean isStructureDirty(boolean refresh)
isStructureDirty
in class AbstractDefinition
refresh
- flag to indicate if the refresh is requested for the
structure.public void setRootStructureName(java.lang.String rootDefName)
setRootStructureName
in class AbstractDefinition
public java.lang.String getRootStructureName()
getRootStructureName
in class AbstractDefinition
public void setIncludeHttpHeaders(boolean mIncludeHttpHeaders)
public boolean isIncludeHttpHeaders()
public void setHttpHeaderParamName(java.lang.String mHttpHeaderParamName)
public java.lang.String getHttpHeaderParamName()
public void loadDefinition(org.w3c.dom.Node node, java.util.Map params)
AbstractURLChildDefinition
loadDefinition
in class AbstractURLChildDefinition
public MethodDef getMethodDef(StructureDef structDef, AdapterContext adapterCtx, java.lang.String dcName)
AbstractURLChildDefinition
getMethodDef
in class AbstractURLChildDefinition
public void setCachingMode(int cachingMode)
setCachingMode
in class AbstractDefinition
public void setID(java.lang.String id)
public java.lang.String getID()
@Deprecated @Concealed public void setEnsureKeyAttribute(boolean ensureKeyAttribute)
@Deprecated @Concealed public void setEnsureStructureV2(boolean ensureStructureV2)