OAXMLWriter (OA Java Code Documentation)

java.lang.Object
- com.viaoa.util.OAXMLWriter

```
public class OAXMLWriter
extends Object
```
OAXMLWriter creates an XML file that can then be read using an OAXMLReader.
If an object has already been stored in the file, then its key will be stored.

See Also:

OAXMLReader

Field Summary

Fields
Modifier and Type	Field and Description
`protected Hashtable`	`hash`
`int`	`indent`
`int`	`indentAmount`
`protected PrintWriter`	`pw`
`static int`	`WRITE_KEYONLY` param used to only write an object key
`static int`	`WRITE_NO` param used to not write an object
`static int`	`WRITE_NONEW_KEYONLY` param used to not write any new objects in a hub, so that Hub does not write new objects.
`static int`	`WRITE_YES` param used to write an object

Constructor Summary

Constructors
Constructor and Description

OAXMLWriter(PrintWriter pw)

OAXMLWriter(String fname)

Constructors
Constructor and Description
`OAXMLWriter(PrintWriter pw)`
`OAXMLWriter(String fname)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addWillBeWriting(OAObject obj)`
`void`	`close()`
`String`	`convertToString(String property, Object value)` Method that can be overwritten to provide custom conversion to String.
`void`	`end()`
`protected void`	`finalize()`
`void`	`flush()`
`String`	`getClassName(Class c)`
`String`	`getCurrentPropertyPath()` Shows the curret list of objects that are being saved.
`String`	`getEncodeMessage()`
`boolean`	`getIncludeEmptyHubs()`
`boolean`	`getIncludeNullProperties()`
`boolean`	`getIncludeOnlyImportMatchProperties()`
`void`	`indent()`
`protected void`	`init()`
`void`	`pop()`
`void`	`print(String line)`
`void`	`printCDATA(String line)` encloses line in XML CDATA tag and internally encodes illegal XML characters
`void`	`println(String line)`
`void`	`printXML(String line)` converts XML codes and encodes illegal XML characters
`void`	`push(String name)` Used internally when writing objects to show the objects that are being written.
`void`	`removeWillBeWriting(OAObject obj)`
`void`	`setEncodeMessage(String msg)` Used to encrypt all data.
`void`	`setFileName(String fname)`
`void`	`setIncludeEmptyHubs(boolean b)`
`void`	`setIncludeNullProperties(boolean b)`
`void`	`setIncludeOnlyImportMatchProperties(boolean b)`
`void`	`setIndentAmount(int x)`
`void`	`setPrintWriter(PrintWriter pw)`
`int`	`shouldWriteProperty(Object obj, String propertyName, Object value)` called by OAObject.write to know if object should be written for a property that references another OAObject.
`boolean`	`willBeIncludedLater(OAObject oaObj)` returns true if this object will be included by another parent object.
`void`	`write(Hub hub)` saves Hub as XML
`void`	`write(OAObject obj)` saves OAObject as XML
`int`	`writeProperty(Object obj, String propertyName, Object value)` Deprecated. use `shouldWriteProperty(Object, String, Object)`
`void`	`writing(Object obj)` hook used to know when an object is being saved.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pw
```
protected PrintWriter pw
```
  - indent
```
public int indent
```
  - indentAmount
```
public int indentAmount
```
  - WRITE_YES
```
public static final int WRITE_YES
```
    param used to write an object
    
    See Also:
    
    Constant Field Values
  - WRITE_KEYONLY
```
public static final int WRITE_KEYONLY
```
    param used to only write an object key
    
    See Also:
    
    Constant Field Values
  - WRITE_NO
```
public static final int WRITE_NO
```
    param used to not write an object
    
    See Also:
    
    Constant Field Values
  - WRITE_NONEW_KEYONLY
```
public static final int WRITE_NONEW_KEYONLY
```
    param used to not write any new objects in a hub, so that Hub does not write new objects. Used in OAObject.log() for M2M links
    
    See Also:
    
    Constant Field Values
  - hash
```
protected Hashtable hash
```
- Constructor Detail
  - OAXMLWriter
```
public OAXMLWriter(String fname)
```
  - OAXMLWriter
```
public OAXMLWriter(PrintWriter pw)
```
- Method Detail
  - setPrintWriter
```
public void setPrintWriter(PrintWriter pw)
```
  - setFileName
```
public void setFileName(String fname)
```
  - setIncludeOnlyImportMatchProperties
```
public void setIncludeOnlyImportMatchProperties(boolean b)
```
  - getIncludeOnlyImportMatchProperties
```
public boolean getIncludeOnlyImportMatchProperties()
```
  - write
```
public void write(OAObject obj)
```
    saves OAObject as XML
  - write
```
public void write(Hub hub)
```
    saves Hub as XML
  - writeProperty
```
public int writeProperty(Object obj,
                         String propertyName,
                         Object value)
```
    Deprecated. use shouldWriteProperty(Object, String, Object)
    
    callback used to know if property should be written
  - shouldWriteProperty
```
public int shouldWriteProperty(Object obj,
                               String propertyName,
                               Object value)
```
    called by OAObject.write to know if object should be written for a property that references another OAObject. This can be overwritten to control which properties are saved. default: if o default = WRITE_YES;
  - addWillBeWriting
```
public void addWillBeWriting(OAObject obj)
```
  - removeWillBeWriting
```
public void removeWillBeWriting(OAObject obj)
```
  - willBeIncludedLater
```
public boolean willBeIncludedLater(OAObject oaObj)
```
    returns true if this object will be included by another parent object.
  - writing
```
public void writing(Object obj)
```
    hook used to know when an object is being saved.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - setIndentAmount
```
public void setIndentAmount(int x)
```
  - flush
```
public void flush()
```
  - close
```
public void close()
```
  - end
```
public void end()
```
  - setEncodeMessage
```
public void setEncodeMessage(String msg)
```
    Used to encrypt all data.
    NOTE: currently only works with printCDATA. This needs to be changed so that all printXX methods encrypt data.
    
    See Also:
    
    OAXMLReader.setDecodeMessage(java.lang.String)
  - getEncodeMessage
```
public String getEncodeMessage()
```
  - printCDATA
```
public void printCDATA(String line)
```
    encloses line in XML CDATA tag and internally encodes illegal XML characters
  - printXML
```
public void printXML(String line)
```
    converts XML codes and encodes illegal XML characters
  - print
```
public void print(String line)
```
  - println
```
public void println(String line)
```
  - indent
```
public void indent()
```
  - init
```
protected void init()
```
  - convertToString
```
public String convertToString(String property,
                              Object value)
```
    Method that can be overwritten to provide custom conversion to String. Called to convert a value to a String when there does not exist an OAConverter for a class.
    
    Returns:
    
    null to skip property.
  - getClassName
```
public String getClassName(Class c)
```
  - setIncludeEmptyHubs
```
public void setIncludeEmptyHubs(boolean b)
```
  - getIncludeEmptyHubs
```
public boolean getIncludeEmptyHubs()
```
  - setIncludeNullProperties
```
public void setIncludeNullProperties(boolean b)
```
  - getIncludeNullProperties
```
public boolean getIncludeNullProperties()
```
  - getCurrentPropertyPath
```
public String getCurrentPropertyPath()
```
    Shows the curret list of objects that are being saved.
  - push
```
public void push(String name)
```
    Used internally when writing objects to show the objects that are being written.
    
    See Also:
    
    getCurrentPropertyPath()
  - pop
```
public void pop()
```

Class OAXMLWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pw

indent

indentAmount

WRITE_YES

WRITE_KEYONLY

WRITE_NO

WRITE_NONEW_KEYONLY

hash

Constructor Detail

OAXMLWriter

OAXMLWriter

Method Detail

setPrintWriter

setFileName

setIncludeOnlyImportMatchProperties

getIncludeOnlyImportMatchProperties

write

write

writeProperty

shouldWriteProperty

addWillBeWriting

removeWillBeWriting

willBeIncludedLater

writing

finalize

setIndentAmount

flush

close

end

setEncodeMessage

getEncodeMessage

printCDATA

printXML

print

println

indent

init

convertToString

getClassName

setIncludeEmptyHubs

getIncludeEmptyHubs

setIncludeNullProperties

getIncludeNullProperties

getCurrentPropertyPath

push

pop