public class RMXMLWriter
extends java.lang.Object
new RMXMLWriter().writeObject(myObjects, "MyDataset.xml");
The Java dataset can take almost any form: a list, map or hierarchy of EJBs, custom Java classes, Java collections classes or even JDBC ResultSets. The resulting XML file is a very clean description of all the public fields, methods and keys/values in the dataset (out to three levels deep, which is the default "degree of separation").
RMXMLWriter performs its conversion in two steps, first abstracting the object into Java Collections and core types using RMMapMaker, then writing the abstraction to XML.
This code currently supports entity subclasses (eg, Vehicle->Car, Vehicle->Truck) by folding them into their base class (eg, Vehicle). A future version might consider buiding an RMSchema that includes an entity "parent" attribute, so that a hierarchy of entities could be mapped instead of just a list. Subtype's would then refer to the base class for a given relation, and each member of the relation would have to specify it's "Class" if different from base.
Copyright (c) 2004 ReportMill Software, Inc. All Rights Reserved. Contact ReportMill
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TAG_ID |
Constructor and Description |
---|
RMXMLWriter()
Creates a basic instance of RMXMLWriter.
|
Modifier and Type | Method and Description |
---|---|
boolean |
forceIds()
Returns whether every written entity should automatically have "id" tag.
|
RMSchema |
getSchema()
Returns the schema.
|
RXElement |
getXML(java.lang.Object anObj,
java.lang.Object userInfo,
int degreeOfSeparation)
Writes given Java dataset and optional userInfo to given path as XML, out to given degree of separation.
|
boolean |
ignore(java.lang.String aName)
Returns whether writer should ignore class/method/field with given name from the serialized object graph.
|
void |
ignoreClass(java.lang.Class aClass)
Tells writer to ignore any member of the given class from the serialized object graph.
|
void |
ignoreClass(java.lang.String aClassName)
Tells writer to ignore any member of the given class name from the serialized object graph.
|
void |
ignoreMember(java.lang.String aFieldName)
Tells writer to ignore any member with the given method/field name from the serialized object graph.
|
boolean |
includeSublassNames()
Returns whether XML should include "Class" attribute when class differs from schema (subclasses only).
|
void |
setForceIds(boolean aFlag)
Sets whether every written entity should automatically have "id" tag.
|
void |
setIncludeSubclassNames(boolean aFlag)
Sets whether XML should include "Class" attribute when class differs from schema (subclasses only).
|
void |
setUseShortClassNames(boolean aFlag)
Sets whether class names should omit path (don't use if full classpath needed or if duplicate class names).
|
boolean |
useShortClassNames()
Returns whether class names should omit path (don't use if full classpath needed or if duplicate class names).
|
void |
writeObject(java.lang.Object anObj,
java.lang.Object userInfo,
java.lang.String aPath,
int degreeOfSeparation)
Writes given Java dataset and optional userInfo to given path as XML, out to given degree of separation.
|
void |
writeObject(java.lang.Object anObj,
java.lang.String aPath)
Writes given Java dataset to given path as XML, out to three levels deep, which is default degree of separation.
|
void |
writeObject(java.lang.Object anObj,
java.lang.String aPath,
int dos)
Writes given Java dataset to given path as XML, out to given degree of separation.
|
public static final java.lang.String TAG_ID
public boolean forceIds()
public void setForceIds(boolean aFlag)
public boolean includeSublassNames()
public void setIncludeSubclassNames(boolean aFlag)
public boolean useShortClassNames()
public void setUseShortClassNames(boolean aFlag)
public void ignoreClass(java.lang.Class aClass)
public void ignoreClass(java.lang.String aClassName)
public void ignoreMember(java.lang.String aFieldName)
public boolean ignore(java.lang.String aName)
public void writeObject(java.lang.Object anObj, java.lang.String aPath)
public void writeObject(java.lang.Object anObj, java.lang.String aPath, int dos)
public void writeObject(java.lang.Object anObj, java.lang.Object userInfo, java.lang.String aPath, int degreeOfSeparation)
public RXElement getXML(java.lang.Object anObj, java.lang.Object userInfo, int degreeOfSeparation)
public RMSchema getSchema()