|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.candle.roma.kxm.KxmMsgConvertOptions
Represents the message conversion options. This object is used to
provide options to the
KxmMessage.convert(String format, KxmMsgConvertOptions options)
method.
KxmMessage
Field Summary | |
static int |
BY_MAP
Message conversion option. See setOptions(int options) |
static int |
DISABLE_NAMESPACES
Message conversion option. See setOptions(int options) |
static int |
HANDLE_NAMESPACES
Message conversion option. See setOptions(int options) |
static int |
HEX_XML_FORMAT
Message conversion option. See setOptions(int options) |
static int |
MAP_REQUIRED
Message conversion option. See setOptions(int options) |
static int |
OLD_TEXT_FORMAT
Message conversion option. See setOptions(int options) |
static int |
SCALAR_AS_ARRAY
Message conversion option. See setOptions(int options) |
static int |
TO_FORMAT
Message conversion option. See setOptions(int options) |
static int |
TO_XML
Message conversion option. See setOptions(int options) |
Constructor Summary | |
KxmMsgConvertOptions()
Creates the object with no options set. |
|
KxmMsgConvertOptions(int options)
Creates the object and sets the specified coversion options. |
Method Summary | |
java.lang.Object |
clone()
Returns a clone of the object. |
long |
getHandle()
|
java.lang.String |
getNsUri()
Returns the XML namespace URI that will be associated with the root element of the converted message. |
int |
getOptions()
Returns the message conversion options. |
void |
setNsUri(java.lang.String uri)
Sets the XML namespace URI that will be associated with the root element of the converted message. |
void |
setOptions(int options)
Sets the message conversion options. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int TO_XML
setOptions(int options)
public static final int TO_FORMAT
setOptions(int options)
public static final int BY_MAP
setOptions(int options)
public static final int MAP_REQUIRED
setOptions(int options)
public static final int HANDLE_NAMESPACES
setOptions(int options)
public static final int OLD_TEXT_FORMAT
setOptions(int options)
public static final int DISABLE_NAMESPACES
setOptions(int options)
public static final int HEX_XML_FORMAT
setOptions(int options)
public static final int SCALAR_AS_ARRAY
setOptions(int options)
Constructor Detail |
public KxmMsgConvertOptions()
public KxmMsgConvertOptions(int options)
options
- Message conversion options.setOptions(int options)
Method Detail |
public int getOptions()
public void setOptions(int options)
options
- Message conversion options.
One of the following mutually exclusive options must be specified:
KxmMsgConvertOptions.TO_XML
A message will be converted into a standalone XML document.
Conversion maps are not used in this case.
KxmMsgConvertOptions.TO_FORMAT
A message will be converted into format defined in the
Metadata Repository. Initially, the conversion engine searches
for a conversion map that is able to convert the current
message format to the target format. The search is performed in
the same namespace where the source format resides. If no
appropriate map found then the format is converted based on
the default conversion rules.
KxmMsgConvertOptions.BY_MAP
A message will be converted by the map defined in the
Metadata Repository. The message cannot be a standalone one
and should have the same format as the source format of the map.
KxmMsgConvertOptions.MAP_REQUIRED
May be used along with the TO_FORMAT option only.
The conversion engine will report an error if the appropriate
conversion map is not found in the Metadata Repository.
By default, the conversion engine silently attempts to perform
implicit conversion. Use this option to avoid the implicit
conversion.
KxmMsgConvertOptions.HANDLE_NAMESPACES
Enables XML Namespace handling.
KxmMsgConvertOptions.OLD_TEXT_FORMAT
Enables handling of the data text representation used in the
eBP 3.1 and earlier versions.
KxmMsgConvertOptions.DISABLE_NAMESPACES
Disables XML Namespace handling. The handling is enabled by default.
KxmMsgConvertOptions.HEX_XML_FORMAT
KxmMsgConvertOptions.SCALAR_AS_ARRAY
public void setNsUri(java.lang.String uri)
uri
- XML namespace URI.public java.lang.String getNsUri()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
public long getHandle()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |