Interface Serializer

  • All Known Implementing Classes:
    SerializerImpl

    public interface Serializer
    This interface provides a means to serialize and/or de-serialize the chart model instance into XML content. Serialization is internally implemented using EMF tools using the Chart XSDs (XML schema definition(s)).
    Author:
    Actuate Corporation
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.io.ByteArrayOutputStream asXml​(Chart cModel, boolean bStripHeaders)
      Write the chart described by the model to a ByteArrayOutputStream.
      Chart fromXml​(java.io.ByteArrayInputStream byaIS, boolean bStripHeaders)
      Reads the chart model from the ByteArrayInputStream.
      ChartPreferences loadPreferences​(java.io.InputStream is)
      Deprecated.
      only reserved for compatibility
      Chart read​(java.io.InputStream is)
      Reads the chart model from the given InputStream
      Chart read​(org.eclipse.emf.common.util.URI uri)
      Reads the chart model from the location defined by the URI provided.
      Chart readEmbedded​(org.eclipse.emf.common.util.URI uri)
      Reads the chart model embedded inside other XML content defined by the URI provided.
      void savePreferences​(ChartPreferences preferences, java.io.OutputStream os)
      Deprecated.
      only reserved for compatibility
      void write​(Chart cModel, java.io.OutputStream os)
      Write the chart described by the model to the OutputStream provided.
      void write​(Chart cModel, org.eclipse.emf.common.util.URI uri)
      Write the chart described by the model to the location defined by the URI provided.
    • Method Detail

      • write

        void write​(Chart cModel,
                   java.io.OutputStream os)
            throws java.io.IOException
        Write the chart described by the model to the OutputStream provided.
        Parameters:
        cModel - The model to be serialized os The OutputStream to which the model is to be serialized
        Throws:
        java.io.IOException
      • write

        void write​(Chart cModel,
                   org.eclipse.emf.common.util.URI uri)
            throws java.io.IOException
        Write the chart described by the model to the location defined by the URI provided.
        Parameters:
        cModel - The model to be serialized uri The URI to which the model is to be serialized
        Throws:
        java.io.IOException
      • asXml

        java.io.ByteArrayOutputStream asXml​(Chart cModel,
                                            boolean bStripHeaders)
                                     throws java.io.IOException
        Write the chart described by the model to a ByteArrayOutputStream.
        Parameters:
        cModel - The model to be serialized bStripHeaders Specifies whether or not the headers are to be removed while serializing the model
        Returns:
        the ByteArrayOutputStream containing the serialized model
        Throws:
        java.io.IOException
      • savePreferences

        @Deprecated
        void savePreferences​(ChartPreferences preferences,
                             java.io.OutputStream os)
                      throws java.io.IOException
        Deprecated.
        only reserved for compatibility
        Saves the chart preferences to the specified OutputStream.
        Parameters:
        preferences - The ChartPreferences object to be saved
        os - The OutputStream to which the preferences are to be written
        Throws:
        java.io.IOException
      • read

        Chart read​(java.io.InputStream is)
            throws java.io.IOException
        Reads the chart model from the given InputStream
        Returns:
        chart model read from the stream
        Throws:
        java.io.IOException
      • read

        Chart read​(org.eclipse.emf.common.util.URI uri)
            throws java.io.IOException
        Reads the chart model from the location defined by the URI provided.
        Parameters:
        uri - URI of the location holding the chart model
        Returns:
        chart model read from the source
        Throws:
        java.io.IOException
      • readEmbedded

        Chart readEmbedded​(org.eclipse.emf.common.util.URI uri)
                    throws java.io.IOException
        Reads the chart model embedded inside other XML content defined by the URI provided.
        Parameters:
        uri - URI of the location holding the embedded chart model
        Returns:
        chart model read from the source
        Throws:
        java.io.IOException
      • fromXml

        Chart fromXml​(java.io.ByteArrayInputStream byaIS,
                      boolean bStripHeaders)
               throws java.io.IOException
        Reads the chart model from the ByteArrayInputStream.
        Parameters:
        byaIS - The ByteArrayInputStream holding the chart model
        bStripHeaders - Specifies whether or not the headers were removed when the chart model was saved
        Returns:
        chart model read from the stream
        Throws:
        java.io.IOException
      • loadPreferences

        @Deprecated
        ChartPreferences loadPreferences​(java.io.InputStream is)
                                  throws java.io.IOException
        Deprecated.
        only reserved for compatibility
        Loads the chart preferences from the InputStream.
        Parameters:
        is - InputStream from which the chart preferences are to be read
        Returns:
        ChartPreferences instance read from the stream
        Throws:
        java.io.IOException