public class ComplexMetadata extends BaseMetadata implements WmTemplateDescriptor
_description, _displayName, _features, _name, _parameters, _resourceBundleManager, _templateURL
INPUT_EXPRESSIONS, INPUT_FIELD_NAMES, OUTPUT_FIELD_NAMES
Modifier | Constructor and Description |
---|---|
protected |
ComplexMetadata() |
Modifier and Type | Method and Description |
---|---|
static ComplexMetadata |
create(com.wm.pkg.art.metadata.ComplexTemplate templateObject,
java.util.Locale locale) |
void |
createFieldMap(java.lang.String[] members,
boolean variable)
Creates a field map.
|
void |
createFieldMap(java.lang.String[] members,
boolean variable,
boolean fillAll)
Creates a field map with the
fillAll flag setting option. |
void |
createTuple(java.lang.String[] members)
Create a tuple.
|
void |
disableAppendAll(java.lang.String fieldMap)
Disable "append all" button in the ASE/ANE.
|
void |
setKey(java.lang.String name)
Sets the key flag for a parameter.
|
void |
setKey(java.lang.String name,
boolean key)
Marks a parameter as key, when
key is set to true . |
void |
setMultiline(java.lang.String name)
Sets the multi-line flag for a parameter.
|
void |
setMultiline(java.lang.String name,
boolean multiline)
Marks a parameter as multi-line, when
multiline is set to true . |
void |
setResourceDomain(java.lang.String name,
java.lang.String resourceDomainName,
java.lang.String[] dependencies)
Sets the resource domain and dependencies for a parameter.
|
void |
setResourceDomain(java.lang.String name,
java.lang.String resourceDomainName,
java.lang.String[] dependencies,
java.lang.String useParam)
Sets the resourceDomain and dependencies for a parameter with use flags.
|
void |
setTreeChooser(java.lang.String[] members,
java.lang.String delimiter)
Creates a tree chooser widget for the parameters specified.
|
void |
setTreeMap(java.lang.String name,
java.lang.String delimiters)
Creates a tree control on a single field (column) in a field map.
|
com.wm.data.IData |
toIData()
renders the content of this object as an IData apprpropriate for ART service invocations.
|
createGroup, getDescription, getDisplayName, getFeatures, getFeatureValue, getName, getParameterDescriptor, getParameters, getTemplateURL, isPassFullPipeline, isShowConnectionName, isSignatureWrapped, setClassName, setDescription, setDescription, setDescriptions, setDisplayName, setDisplayName, setFeatureValue, setGroupName, setHidden, setHidden, setMaxSeqLength, setMaxStringLength, setMinSeqLength, setMinSeqLength, setMinStringLength, setName, setPassFullPipeline, setPassword, setPassword, setRequired, setRequired, setResourceDomainLookup, setResourceDomainLookup, setResourceDomainLookup, setShowConnectionName, setSignatureWrapped, setTemplateURL, setValidValues
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createGroup, getDescription, getDisplayName, getFeatureValue, getName, isPassFullPipeline, isShowConnectionName, isSignatureWrapped, setDescription, setDescription, setDescriptions, setDisplayName, setDisplayName, setFeatureValue, setGroupName, setHidden, setHidden, setMaxSeqLength, setMaxStringLength, setMinSeqLength, setMinSeqLength, setMinStringLength, setName, setPassFullPipeline, setPassword, setPassword, setRequired, setRequired, setShowConnectionName, setSignatureWrapped, setValidValues
public static ComplexMetadata create(com.wm.pkg.art.metadata.ComplexTemplate templateObject, java.util.Locale locale) throws com.wm.pkg.art.error.DetailedException
com.wm.pkg.art.error.DetailedException
public void createFieldMap(java.lang.String[] members, boolean variable) throws AdapterException
createFieldMap
in interface WmTemplateDescriptor
members
- ordered list of field map members.variable
- set to true to create a variable field mapAdapterException
- if any of the field map members doesn't exist.public void createFieldMap(java.lang.String[] members, boolean variable, boolean fillAll) throws AdapterException
WmTemplateDescriptor
fillAll
flag setting option. Include the names
of all of the parameters you want in the field map in the members array. When
variable
is set to true, the number of fields that appear in the Adapter
Service Editor or the Adapter Notification Editor can vary. The editors provide several
GUI elements that enable users to add and delete fields.
When variable
is set to false (non-variable field map), fillAll
is always set to true. When variable
is set to true (variable field map) and
fillAll
is set to true, the editor will fill in all the available data.
When variable
is set to true (variable field map) and fillAll
is set to false, the user can add one row at a time using the editor.createFieldMap
in interface WmTemplateDescriptor
members
- an ordered list of field map membersvariable
- set to true to create a variable field mapAdapterException
- if any of the field map members do not existpublic void createTuple(java.lang.String[] members) throws AdapterException
createTuple
in interface WmTemplateDescriptor
members
- ordered list of tuple members.AdapterException
- if any of the tuple members doesn't exist.public void disableAppendAll(java.lang.String fieldMap) throws AdapterException
disableAppendAll
in interface WmTemplateDescriptor
fieldMap
- The name of field map. The first member of field map.AdapterException
- throw error if there is no field map created, the name of
field map is incorrect.public void setKey(java.lang.String name) throws AdapterException
WmTemplateDescriptor
setKey
in interface WmTemplateDescriptor
name
- the name of the parameterAdapterException
- if the parameter does not existpublic void setKey(java.lang.String name, boolean key) throws AdapterException
WmTemplateDescriptor
key
is set to true
.
This method only applies to sequence parameters. A sequence parameter that is
a key requires unique values for each sequence entry.setKey
in interface WmTemplateDescriptor
name
- the name of the parameterkey
- set to true to make the parameter a key; otherwise, set to false.AdapterException
- if the parameter does not existpublic void setMultiline(java.lang.String name) throws AdapterException
WmTemplateDescriptor
setMultiline
in interface WmTemplateDescriptor
name
- the name of the parameterAdapterException
- if the parameter does not existpublic void setMultiline(java.lang.String name, boolean multiline) throws AdapterException
WmTemplateDescriptor
multiline
is set to true
.
For parameters that are marked as multi-line, the Adapter Service/Notification
Editors will present a GUI widget that allows users to enter multiple lines of text.setMultiline
in interface WmTemplateDescriptor
name
- the name of the parametermultiline
- set to true to use a multiline GUI element; otherwise, set to false.AdapterException
- if the parameter does not existpublic void setResourceDomain(java.lang.String name, java.lang.String resourceDomainName, java.lang.String[] dependencies) throws AdapterException
setResourceDomain
in interface WmTemplateDescriptor
name
- name of parameter.resourceDomainName
- the actual name of the resoure domain itself. Must be
registered in the adapter.dependencies
- list of dependencies. Must be the name of parameters.Prefix
with '*' if dependency is sequence, and you need all values of
sequence.AdapterException
- One of the values is not a parameter, or a reousrce domain
is not registered in the adapter.public void setResourceDomain(java.lang.String name, java.lang.String resourceDomainName, java.lang.String[] dependencies, java.lang.String useParam) throws AdapterException
WmTemplateDescriptor
boolean[]
parameter as the final argument to this method.setResourceDomain
in interface WmTemplateDescriptor
name
- the name of the parameterresourceDomainName
- the name of the resourceDomain. The resourceDomainName must
be registered using the
WmManagedConnection.registerResourceDomain(com.wm.adk.metadata.WmAdapterAccess)
method.dependencies
- the list of dependencies, which must be the names of parameters.
Prefix the dependency parameter with an asterisk (*
)
if the dependency parameter contains a sequence, and you need all
values of the sequence.AdapterException
- if one or more of the values is not a parameter, or if the
resourceDomain is not registered in the adapter.public void setTreeChooser(java.lang.String[] members, java.lang.String delimiter) throws AdapterException
WmTemplateDescriptor
For example, suppose you have three parameters "paramA", "paramB", and "paramC", and their respective values are "valueA", "valueB", and "valueC". If you append those values with delimiters such as "valueA.valueB.valueC", the editor will display them as follows:
valueA |_valueB |_valueC
setTreeChooser
in interface WmTemplateDescriptor
delimiter
- to be used when combining values from multiple parameters for displayAdapterException
- if any of the tree parameters do not existpublic void setTreeMap(java.lang.String name, java.lang.String delimiters) throws AdapterException
WmTemplateDescriptor
For example, a parameter with the value "A.B.C" will become a tree with the following structure:
A |_B |_C
setTreeMap
in interface WmTemplateDescriptor
name
- the name of the parameter to use for the tree structuredelimiters
- the list of characters to use for splitting a single parameter into
multiple valuesAdapterException
- if the parameter doesn't exist or is not the first column of
a field map.public com.wm.data.IData toIData()
Copyright © 2003 - 2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.