Class XMLMetaDataSerializer

java.lang.Object
org.apache.openjpa.lib.meta.XMLMetaDataSerializer
All Implemented Interfaces:
MetaDataSerializer
Direct Known Subclasses:
CFMetaDataSerializer, XMLSchemaSerializer

public abstract class XMLMetaDataSerializer extends Object implements MetaDataSerializer
Abstract base type for serlializers that transfer groups of objects to XML. Includes a way of serializing objects back to the XML files they were parsed from. Serializers are not thread safe.
Author:
Abe White
  • Constructor Details

    • XMLMetaDataSerializer

      public XMLMetaDataSerializer()
  • Method Details

    • getLog

      public Log getLog()
      The log to write to.
    • setLog

      public void setLog(Log log)
      The log to write to.
    • serialize

      public void serialize(int flags) throws IOException
      Description copied from interface: MetaDataSerializer
      Serialize the current set of objects to the files from which they were parsed. Any objects for which a source file cannot be determined will not be included in the output.
      Specified by:
      serialize in interface MetaDataSerializer
      Parameters:
      flags - bit flags specifying the output flags; e.g. MetaDataSerializer.PRETTY
      Throws:
      IOException
    • serialize

      public void serialize(Map output, int flags) throws IOException
      Description copied from interface: MetaDataSerializer
      Serialize the current set of objects to the files from which they were parsed. The objects must implement the SourceTracker interface.
      Specified by:
      serialize in interface MetaDataSerializer
      Parameters:
      output - if null, then serialize directly to the file system; otherwise, populate the specified Map with keys that are the File instances, and values that are the String contents of the MetaData
      flags - bit flags specifying the output flags; e.g. MetaDataSerializer.PRETTY
      Throws:
      IOException
    • prepareWrite

      protected File prepareWrite(File file) throws IOException
      Prepare to write to the given file. Back up the file and make sure the path to it is created.
      Throws:
      IOException
    • getFileMap

      protected Map<File, Collection<Object>> getFileMap()
      Returns a Map with keys of the File to be written to, and values of a Collection of SourceTracker instances.
    • getSourceFile

      protected File getSourceFile(Object obj)
      Return the source file for the given instance. By default, checks to see if the instance implements SourceTracker.
    • serialize

      public void serialize(File file, int flags) throws IOException
      Description copied from interface: MetaDataSerializer
      Serialize the current set of objects to the given file.
      Specified by:
      serialize in interface MetaDataSerializer
      Parameters:
      flags - bit flags specifying the output flags; e.g. MetaDataSerializer.PRETTY | MetaDataSerializer.APPEND
      Throws:
      IOException
    • serialize

      public void serialize(Writer out, int flags) throws IOException
      Description copied from interface: MetaDataSerializer
      Serialize the current set of objects to the given stream.
      Specified by:
      serialize in interface MetaDataSerializer
      Parameters:
      flags - bit flags specifying the output flags; e.g. MetaDataSerializer.PRETTY
      Throws:
      IOException
    • serialize

      public void serialize(Result result, int flags) throws SAXException
      Serialize the current set of objects to the given result.
      Throws:
      SAXException
    • serialize

      public void serialize(ContentHandler handler, int flags) throws SAXException
      Serilize the current set of objects to a series of SAX events on the given handler.
      Throws:
      SAXException
    • isVerbose

      protected boolean isVerbose()
      Whether this serialization is in verbose mode.
    • currentBackupFile

      protected File currentBackupFile()
      The backup file made for the current file being parsed.
    • startElement

      protected void startElement(String name) throws SAXException
      Start an element with the current attribute settings. Clears the attributes as well.
      Throws:
      SAXException
    • endElement

      protected void endElement(String name) throws SAXException
      End the current element.
      Throws:
      SAXException
    • addText

      protected void addText(String text) throws SAXException
      Add text to the current element.
      Throws:
      SAXException
    • addAttribute

      protected void addAttribute(String name, String value)
      Add an attribute to the current group.
    • getAttributes

      protected Attributes getAttributes()
      The current attributes.
    • addComments

      protected void addComments(String[] comments) throws SAXException
      Add a comment to the stream.
      Throws:
      SAXException
    • addComments

      protected void addComments(Object obj) throws SAXException
      Write the given entity's comments. By default, tests if entity is Commentable.
      Throws:
      SAXException
    • reset

      protected void reset()
      Reset serialization state for the next document.
    • serialize

      protected abstract void serialize(Collection<Object> objs) throws SAXException
      Serialize the given set of objects.
      Throws:
      SAXException
    • getObjects

      protected abstract Collection<Object> getObjects()
      Return the current set of objects for serialization.