Public Types | Public Member Functions | Friends | List of all members
SerializationOptions Class Reference

This class defines a set of values used to define the way a serialization can be made over Items or Collections collections. More...

Public Types

enum  ByteOrderMark { ZORBA_API_BYTE_ORDER_MARK_YES, ZORBA_API_BYTE_ORDER_MARK_NO }
 
enum  EscapeUriAttributes { ZORBA_API_ESCAPE_URI_ATTRIBUTES_YES, ZORBA_API_ESCAPE_URI_ATTRIBUTES_NO }
 
enum  IncludeContentType { ZORBA_API_INCLUDE_CONTENT_TYPE_YES, ZORBA_API_INCLUDE_CONTENT_TYPE_NO }
 
enum  Indent { ZORBA_API_INDENT_YES, ZORBA_API_INDENT_NO }
 
enum  NormalizationForm {
  ZORBA_API_NORMALIZATION_FORM_NFC, ZORBA_API_NORMALIZATION_FORM_NFD, ZORBA_API_NORMALIZATION_FORM_NFKC, ZORBA_API_NORMALIZATION_FORM_NFKD,
  ZORBA_API_NORMALIZATION_FORM_FULLY_normalized, ZORBA_API_NORMALIZATION_FORM_NONE
}
 
enum  OmitXMLDeclaration { ZORBA_API_OMIT_XML_DECLARATION_YES, ZORBA_API_OMIT_XML_DECLARATION_NO }
 
enum  SerializationMethod {
  ZORBA_API_SERIALIZATION_METHOD_XML, ZORBA_API_SERIALIZATION_METHOD_HTML, ZORBA_API_SERIALIZATION_METHOD_XHTML, ZORBA_API_SERIALIZATION_METHOD_TEXT,
  ZORBA_API_SERIALIZATION_METHOD_BINARY
}
 
enum  Standalone { ZORBA_API_STANDALONE_YES, ZORBA_API_STANDALONE_NO, ZORBA_API_STANDALONE_OMIT }
 
enum  UndeclarePrefixes { ZORBA_API_UNDECLARE_PREFIXES_YES, ZORBA_API_UNDECLARE_PREFIXES_NO }
 

Public Member Functions

void setByteOrderMark (ByteOrderMark aByteOrderMark)
 
void setEscapeUriAttributes (EscapeUriAttributes aEscapeUriAttributes)
 
void setIncludeContentType (IncludeContentType aIncludeContentType)
 
void setIndent (Indent aIndent)
 
void setNormalizationForm (NormalizationForm aNormalizationForm)
 
void setOmitXMLDeclaration (OmitXMLDeclaration aOmitXMLDeclaration)
 
void setSerializationMethod (SerializationMethod aSerializationMethod)
 
void setSerializerOption (const std::string &parameter, const std::string &value)
 /brief Set the serialization options given a string parameter and a string value More...
 
void setStandalone (Standalone aStandalone)
 
void setUndeclarePrefixes (UndeclarePrefixes aUndeclarePrefixes)
 

Friends

class Item
 
class XQuery
 

Detailed Description

This class defines a set of values used to define the way a serialization can be made over Items or Collections collections.

Default values:

Definition at line 34 of file SerializationOptions.h.

Member Enumeration Documentation

enum SerializationOptions::ByteOrderMark
Enumerator
ZORBA_API_BYTE_ORDER_MARK_YES 
ZORBA_API_BYTE_ORDER_MARK_NO 

Definition at line 49 of file SerializationOptions.h.

enum SerializationOptions::EscapeUriAttributes
Enumerator
ZORBA_API_ESCAPE_URI_ATTRIBUTES_YES 
ZORBA_API_ESCAPE_URI_ATTRIBUTES_NO 

Definition at line 56 of file SerializationOptions.h.

enum SerializationOptions::IncludeContentType
Enumerator
ZORBA_API_INCLUDE_CONTENT_TYPE_YES 
ZORBA_API_INCLUDE_CONTENT_TYPE_NO 

Definition at line 62 of file SerializationOptions.h.

enum SerializationOptions::Indent
Enumerator
ZORBA_API_INDENT_YES 
ZORBA_API_INDENT_NO 

Definition at line 67 of file SerializationOptions.h.

enum SerializationOptions::NormalizationForm
Enumerator
ZORBA_API_NORMALIZATION_FORM_NFC 
ZORBA_API_NORMALIZATION_FORM_NFD 
ZORBA_API_NORMALIZATION_FORM_NFKC 
ZORBA_API_NORMALIZATION_FORM_NFKD 
ZORBA_API_NORMALIZATION_FORM_FULLY_normalized 
ZORBA_API_NORMALIZATION_FORM_NONE 

Definition at line 72 of file SerializationOptions.h.

enum SerializationOptions::OmitXMLDeclaration
Enumerator
ZORBA_API_OMIT_XML_DECLARATION_YES 
ZORBA_API_OMIT_XML_DECLARATION_NO 

Definition at line 81 of file SerializationOptions.h.

enum SerializationOptions::SerializationMethod
Enumerator
ZORBA_API_SERIALIZATION_METHOD_XML 
ZORBA_API_SERIALIZATION_METHOD_HTML 
ZORBA_API_SERIALIZATION_METHOD_XHTML 
ZORBA_API_SERIALIZATION_METHOD_TEXT 
ZORBA_API_SERIALIZATION_METHOD_BINARY 

Definition at line 40 of file SerializationOptions.h.

enum SerializationOptions::Standalone
Enumerator
ZORBA_API_STANDALONE_YES 
ZORBA_API_STANDALONE_NO 
ZORBA_API_STANDALONE_OMIT 

Definition at line 86 of file SerializationOptions.h.

enum SerializationOptions::UndeclarePrefixes
Enumerator
ZORBA_API_UNDECLARE_PREFIXES_YES 
ZORBA_API_UNDECLARE_PREFIXES_NO 

Definition at line 92 of file SerializationOptions.h.

Member Function Documentation

void SerializationOptions::setByteOrderMark ( ByteOrderMark  aByteOrderMark)
void SerializationOptions::setEscapeUriAttributes ( EscapeUriAttributes  aEscapeUriAttributes)
void SerializationOptions::setIncludeContentType ( IncludeContentType  aIncludeContentType)
void SerializationOptions::setIndent ( Indent  aIndent)
void SerializationOptions::setNormalizationForm ( NormalizationForm  aNormalizationForm)
void SerializationOptions::setOmitXMLDeclaration ( OmitXMLDeclaration  aOmitXMLDeclaration)
void SerializationOptions::setSerializationMethod ( SerializationMethod  aSerializationMethod)
void SerializationOptions::setSerializerOption ( const std::string &  parameter,
const std::string &  value 
)

/brief Set the serialization options given a string parameter and a string value

Parameters
parameterThe parameter to be changed
valueThe value to be assigned in a string form
void SerializationOptions::setStandalone ( Standalone  aStandalone)
void SerializationOptions::setUndeclarePrefixes ( UndeclarePrefixes  aUndeclarePrefixes)

Friends And Related Function Documentation

friend class Item
friend

Definition at line 36 of file SerializationOptions.h.

friend class XQuery
friend

Definition at line 37 of file SerializationOptions.h.

The documentation for this class was generated from the following file:
blog comments powered by Disqus