|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataConverterPlugin
This interface must be implemented by any class referenced by a Data-Admin-MetadataConverter instance. It is assumed that a class implementing this interface is used in an interactive environment and therefore this interface provides methods that must be invoked in a particular order to guide an interactive user through the process of metadata conversion 1. After an instance of the converter is created there are certain parameters that should be set before the processing can continue, These parameter names and descriptions can be retrieved via 'getInitParameterDescriptions' method and they should be set via 'addParameters' method 2. After that the 'getLookupParameters' method should be executed to retrieve a list of the lookup parameters For each lookup parameter a 'getLookupParameterValues' method should be executed to obtain lookup parameter value(s). NOTE that this method should be invoked for each lookup parameter in the same order the lookup parameters are listed by the 'getLookupParameters' method. A helper method 'getLookupParameterDescription' can be used to obtain description of the specified lookup parameter 3. 'getProcessingParameterDescription' should be called to obtain descriptions of the remaining converter parameters. These parameters may be set via 'addParameters' method or as the first parameter of the 'convert' method.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
VERSION
|
Method Summary | |
---|---|
void |
addLookupParameter(java.lang.String aParamName,
java.util.List aValues)
Add lookup parameter |
void |
addParameters(java.util.HashMap aParameters)
add converter input parameters. |
void |
convert(java.util.HashMap aConversionParams,
java.io.Writer aWriter)
This method converts an input object into a metadata document. |
java.lang.String |
getHelpURI(java.lang.String aStepName)
Allows you to obtain the URI of a help file within the Pega-Online help. |
java.util.HashMap |
getInitialParameterAlternativeMarkup()
This method returns a HashMap which contains alternative HTML markup any-combination-of/all-of the initial parameters. |
java.util.HashMap |
getInitialParameterDefaultValues()
Returns a HashMap containing default values for the initial parameters. |
java.util.HashMap |
getInitParameterDescriptions()
get initialization parameter descriptions |
java.util.HashMap |
getInitParameterFriendlyNames()
Get the 'human readable' names for the initial parameters. |
java.lang.String |
getInstructions(java.lang.String aStepName)
Allows you to get the instructions for the user. |
java.lang.String |
getLookupParameterDescription(java.lang.String aLookupParameterName)
Get lookup parameter description |
java.lang.String[] |
getLookupParameters()
get lookup parameters |
java.util.List |
getLookupParameterValues(java.lang.String aLookupParameterName)
Get lookup parameter values this method should be called for every lookup parameter AND IN THE SAME order as returned by the 'getLookupParameters' method |
java.lang.String |
getPluginInfo()
Get this converter description. |
java.util.HashMap |
getProcessingParameterAlternativeMarkup()
This method returns a HashMap which contains alternative HTML markup any-combination-of/all-of the processing parameters. |
java.util.HashMap |
getProcessingParameterDefaultValues()
Returns a HashMap containing default values for the initial parameters. |
java.util.HashMap |
getProcessingParameterDescriptions()
Get processing parameter descriptions |
java.util.HashMap |
getProcessingParameterFriendlyNames()
Get the 'human readable' names for the processing parameters. |
java.util.List |
getRequiredInitParameters()
Retrieves a list of the initial parameter keys that are meant to be required parameters. |
java.util.List |
getRequiredProcessingParameters()
Retrieves a list of the processing parameter keys that are meant to be required parameters. |
java.lang.String |
getTargetFormat()
Get the output document type |
boolean |
LookupParameterHasMultipleValues(java.lang.String aLookupParameterName)
Can lookup parameter have multiple values |
boolean |
moreProcessingParameters(java.util.HashMap aProcssingParams)
Returns true iff plugin requires caller to enter additional processing parameters. |
void |
setPRAPIHandle(java.lang.Object aPRAPIHandle)
Set PegaRules Public API handle |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final java.lang.String VERSION
Method Detail |
---|
void setPRAPIHandle(java.lang.Object aPRAPIHandle)
aPRAPIHandle
- a handle to PegaRules Public APIs.void addParameters(java.util.HashMap aParameters) throws java.lang.Exception
aParameters
- A HashMap containing parameters and their values.
java.lang.Exception
- if a parameter name is not validvoid addLookupParameter(java.lang.String aParamName, java.util.List aValues) throws java.lang.Exception
aParamName
- aValues
-
java.lang.Exception
- if a lookup parameter name is not validvoid convert(java.util.HashMap aConversionParams, java.io.Writer aWriter) throws java.lang.Exception
aConversionParams
- A HashMap containing conversion parameters .aWriter
- The output Writer object to write the document to.
java.lang.Exception
- if a required parameter is missing or a conversion source object is not acessiblejava.util.HashMap getInitParameterDescriptions()
java.util.HashMap getInitParameterFriendlyNames()
java.lang.String[] getLookupParameters()
java.lang.String getLookupParameterDescription(java.lang.String aLookupParameterName) throws java.lang.Exception
aLookupParameterName
-
java.lang.Exception
- if a lookup parameter name is not validjava.util.HashMap getProcessingParameterDescriptions()
java.util.HashMap getProcessingParameterFriendlyNames()
java.util.List getLookupParameterValues(java.lang.String aLookupParameterName) throws java.lang.Exception
aLookupParameterName
-
java.lang.Exception
- if a parameter name is invalid or a conversion source object is not acessiblejava.lang.String getPluginInfo()
java.lang.String getTargetFormat()
boolean LookupParameterHasMultipleValues(java.lang.String aLookupParameterName) throws java.lang.Exception
aLookupParameterName
-
java.lang.Exception
- if a lookup parameter name is not validboolean moreProcessingParameters(java.util.HashMap aProcssingParams) throws java.lang.Exception
aProcssingParams
- a HashMap containing processing(conversion) parameters and their values.
java.lang.Exception
java.util.List getRequiredInitParameters()
java.util.List getRequiredProcessingParameters()
java.lang.String getInstructions(java.lang.String aStepName) throws java.lang.Exception
aStepName
- The value is either one of the lookup
parameter names, "INITIAL_PAMAETERS" (for
specifying the initial parameter step), or
"PROCESSING_PARAMETERS" (for specifying
the processing parameters).
java.lang.Exception
java.lang.String getHelpURI(java.lang.String aStepName) throws java.lang.Exception
aStepName
- The value is either one of the lookup
parameter names, "INITIAL_PAMAETERS" (for
specifying the initial parameter step), or
"PROCESSING_PARAMETERS" (for specifying
the processing parameters).
java.lang.Exception
java.util.HashMap getInitialParameterAlternativeMarkup()
java.util.HashMap getProcessingParameterAlternativeMarkup()
java.util.HashMap getInitialParameterDefaultValues()
java.util.HashMap getProcessingParameterDefaultValues()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |