JGraph X 1.2.0.8


com.mxgraph.io
Class mxModelCodec

java.lang.Object
  extended by com.mxgraph.io.mxObjectCodec
      extended by com.mxgraph.io.mxModelCodec

public class mxModelCodec
extends mxObjectCodec

Codec for mxGraphModels. This class is created and registered dynamically at load time and used implicitely via mxCodec and the mxCodecRegistry.


Field Summary
 
Fields inherited from class com.mxgraph.io.mxObjectCodec
exclude, idrefs, mapping, reverse, template
 
Constructor Summary
mxModelCodec()
          Constructs a new model codec.
mxModelCodec(Object template)
          Constructs a new model codec for the given template.
mxModelCodec(Object template, String[] exclude, String[] idrefs, Map<String,String> mapping)
          Constructs a new model codec for the given arguments.
 
Method Summary
 Node beforeDecode(mxCodec dec, Node node, Object into)
          Reads the cells into the graph model.
 Node encode(mxCodec enc, Object obj)
          Encode the given mxGraphModel by writing a (flat) XML sequence of cell nodes as produced by the mxCellCodec.
 
Methods inherited from class com.mxgraph.io.mxObjectCodec
afterDecode, afterEncode, beforeEncode, cloneTemplate, convertValueFromXml, convertValueToXml, decode, decode, decodeAttribute, decodeAttributes, decodeChild, decodeChildren, decodeNode, encodeElements, encodeFields, encodeObject, encodeValue, getAccessor, getAttributeName, getField, getFieldName, getFieldValue, getMethod, getTemplate, isExcluded, isPrimitiveValue, isReference, processInclude, setFieldValue, writeAttribute, writeComplexAttribute, writePrimitiveAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

mxModelCodec

public mxModelCodec()
Constructs a new model codec.


mxModelCodec

public mxModelCodec(Object template)
Constructs a new model codec for the given template.


mxModelCodec

public mxModelCodec(Object template,
                    String[] exclude,
                    String[] idrefs,
                    Map<String,String> mapping)
Constructs a new model codec for the given arguments.

Method Detail

encode

public Node encode(mxCodec enc,
                   Object obj)
Encode the given mxGraphModel by writing a (flat) XML sequence of cell nodes as produced by the mxCellCodec. The sequence is wrapped-up in a node with the name root.

Overrides:
encode in class mxObjectCodec
Parameters:
enc - Codec that controls the encoding process.
obj - Object to be encoded.
Returns:
Returns the resulting XML node that represents the given object.

beforeDecode

public Node beforeDecode(mxCodec dec,
                         Node node,
                         Object into)
Reads the cells into the graph model. All cells are children of the root element in the node.

Overrides:
beforeDecode in class mxObjectCodec
Parameters:
dec - Codec that controls the decoding process.
node - XML node to be decoded.
into - Object to encode the node into.
Returns:
Returns the node used for the default decoding.

JGraph X 1.2.0.8


Copyright (c) 2008 Gaudenz Alder. All rights reserved.