Package oracle.stellent.ridc.model.serialize

Class HdaBinderSerializer

java.lang.Object
oracle.stellent.ridc.model.serialize.HdaBinderSerializer
All Implemented Interfaces:
Serializable
public class HdaBinderSerializer extends Object implements Serializable
Serializes a databinder to HDA format
See Also:

  • Field Details

    • DATA_TYPES

      public static final String[] DATA_TYPES
      Internally used data types that are supported in the HDA format that the databinder writes to, and reads from.

    • REPLACEMENT_CHARACTER

      public static final byte[] REPLACEMENT_CHARACTER

  • Constructor Details

    • HdaBinderSerializer

      public HdaBinderSerializer(String encoding, DataFactory dataFactory)

    • HdaBinderSerializer

      public HdaBinderSerializer(String encoding, DataFactory dataFactory, boolean skipIdcHeaderProps)

  • Method Details

    • getDataFactory

      public DataFactory getDataFactory()

    • parseBinder

      public DataBinder parseBinder(InputStream inputStream) throws IOException
      Parses a BufferedReader object, and loads up the data into a new DataBinder object
      Parameters:
      inputStream - the binder input stream
      Returns:
      the binder
      Throws:
      IOException

    • parseBinder

      public DataBinder parseBinder(Reader inputReader) throws IOException
      Parses a BufferedReader object, and loads up the data into a new DataBinder object
      Parameters:
      inputReader - the reader containing the binder characters
      Returns:
      the binder
      Throws:
      IOException

    • serializeBinder

      public void serializeBinder(OutputStream outputStream, DataBinder dataBinder) throws IOException
      Writes out the local data, option lists, and result sets in hda format.
      Parameters:
      outputStream - the stream to write the binder
      dataBinder - the data binder to serialize
      Throws:
      IOException - if an exception occurs during serialization

    • serializeBinder

      public void serializeBinder(OutputStream outputStream, DataBinder dataBinder, Protocol.NullHandlingStrategy nullStrategy) throws IOException
      Writes out the local data, option lists, and result sets in hda format.
      Parameters:
      outputStream - the stream to write the binder
      dataBinder - the data binder to serialize
      nullStrategy - how to treat null value localdata props
      Throws:
      IOException - if an exception occurs during serialization

    • serializeBinder

      public void serializeBinder(Writer writer, DataBinder dataBinder) throws IOException
      Writes out the local data, option lists, and result sets in hda format.
      Parameters:
      writer - the writer to send the binder
      dataBinder - the data binder to serialize
      Throws:
      IOException - if an exception occurs during serialization

    • serializeBinder

      public void serializeBinder(Writer writer, DataBinder dataBinder, Protocol.NullHandlingStrategy nullStrategy) throws IOException
      Writes out the local data, option lists, and result sets in hda format.
      Parameters:
      writer - the writer to send the binder
      dataBinder - the data binder to serialize
      nullStrategy - how to treat null value localdata props
      Throws:
      IOException - if an exception occurs during serialization

    • parseProperties

      protected boolean parseProperties(DataBinder dataBinder, String name, BufferedReader reader) throws IOException
      Parse hda formatted properties, and merge the values into the local data if those values are not from the environment.
      Parameters:
      dataBinder - the data binder
      name - the properties name
      reader - the input reader
      Returns:
      true if successful
      Throws:
      IOException

    • readProperties

      protected boolean readProperties(BufferedReader reader, DataObject props, String endMark, boolean isJava) throws IOException
      Read properties values in from a buffered reader and into a properties object.
      Parameters:
      reader - the input reader
      props - the data object to send the properties
      endMark - the end mark to look for
      isJava - true if this is a java-based request
      Returns:
      true if the parsing was successful
      Throws:
      IOException

    • parseNameValue

      protected boolean parseNameValue(DataObject dataObject, String envPair, String delimiter)
      Split a name-value pair separated by a delimiter into its parts, and place the value in the local data
      Parameters:
      dataObject - the dataObject to store the result
      envPair - the encoded name/value pair
      delimiter - the delimiting character in the envPair
      Returns:
      true if successful

    • readToEnd

      protected void readToEnd(BufferedReader reader) throws IOException
      Advance the reader until the '@end' value is found on a line.
      Parameters:
      reader - the input reader
      Throws:
      IOException

    • parseOptionList

      protected void parseOptionList(DataBinder dataBinder, String name, BufferedReader reader) throws IOException
      Parse the buffered reader, and create a new option list with the data contained in it, until the @end line is reached. The option list will then be placed in this DataBinder object
      Throws:
      IOException

    • readLine

      protected String readLine(BufferedReader reader, boolean suppress) throws IOException
      Reads a line from a reader, and throws an exception if it cannot, unless 'suppress' is set to true.
      Throws:
      IOException

    • parseResultSet

      protected void parseResultSet(DataBinder dataBinder, String rName, BufferedReader reader) throws IOException
      Parses the LWDataBinder object for the result set with a certain name
      Parameters:
      rName - The name of the result set
      reader - A character stream to be parsed to find the result set
      Throws:
      IOException

    • readResultSetHeader

      protected List<DataResultSet.Field> readResultSetHeader(BufferedReader bReader) throws IOException
      Parses the column information for the result set from a character stream
      Parameters:
      bReader - Character stream containing the result set information
      Returns:
      The number of fields in the parsed result set.
      Throws:
      IOException

    • getTypeIndex

      protected int getTypeIndex(DataResultSet.Field.Type type)
      This returns the index (or the numerical value) of the type.
      Parameters:
      type - the field type
      Returns:
      the numerical value of the type

    • getFieldType

      protected int getFieldType(String fieldData)
      Parse and get the numerical value of the field type given a string. The field type is either the first integer that is in the string.
      Parameters:
      fieldData -
      Returns:

    • packageProperties

      protected void packageProperties(Writer writer, DataObject dataObject, String name, Protocol.NullHandlingStrategy nullStrategy) throws IOException
      Turns the properties object into a hda formatted string, and writes the data to the writer.
      Throws:
      IOException

    • packageResultSet

      protected void packageResultSet(Writer writer, DataResultSet aSet, String name) throws IOException
      Turns the result set into a hda formatted string, and writes the data to the writer.
      Throws:
      IOException

    • packageOptionList

      protected void packageOptionList(Writer writer, List<String> options, String name) throws IOException
      Turns the option list into a hda formatted string, and writes the data to the writer.
      Throws:
      IOException

    • getBytes

      protected byte[] getBytes(String str) throws UnsupportedEncodingException
      Utility function to obtain a byte stream based on the encoding set, or to the default system encoding if no encoding is set.
      Throws:
      UnsupportedEncodingException

    • getEncoding

      public String getEncoding()
      Obtain the file encoding for the files referenced in this object.

    • setEncoding

      public void setEncoding(String encoding)
      Set the encoding for the files referenced in this object.