com.crystaldecisions.sdk.occa.report.exportoptions
Class CharacterSeparatedValuesExportFormatOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.exportoptions.CharacterSeparatedValuesExportFormatOptions
All Implemented Interfaces:
ICharacterSeparatedValuesExportFormatOptions, IExportFormatOptions, IClone

public class CharacterSeparatedValuesExportFormatOptions
extends java.lang.Object
implements ICharacterSeparatedValuesExportFormatOptions

This object is used to set the format options for a report that is to be exported to a Separated Values (CSV) format. When possible, use the ICharacterSeparatedValuesExportFormatOptions interface for manipulating this object.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.occa.report.exportoptions.ICharacterSeparatedValuesExportFormatOptions
ICharacterSeparatedValuesExportFormatOptions.ExportMode, ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption
 
Constructor Summary
CharacterSeparatedValuesExportFormatOptions()
           
CharacterSeparatedValuesExportFormatOptions(ICharacterSeparatedValuesExportFormatOptions src)
           
 
Method Summary
 void checkValidity(java.util.Locale locale)
          Verifies that the export options are valid for a given locale.
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 java.lang.String getDelimiter()
           Gets the delimiter that is used to enclose all non-numeric report fields in the output file.
 ICharacterSeparatedValuesExportFormatOptions.ExportMode getExportMode()
           Gets the ExportMode of the report.
 ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getGroupSectionsOption()
           Gets the group sections option of the report.
 boolean getPreserveDateFormatting()
          Deprecated.  
 boolean getPreserveNumberFormatting()
          Deprecated.  
 ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getReportSectionsOption()
           Gets the report sections option of the report.
 java.lang.String getSeparator()
           Gets the character that is used to separate one report field from another in the output file.
 boolean hasContent(java.lang.Object obj)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void setDelimiter(java.lang.String Delimiter)
           Sets the delimiter that is used to enclose all non-numeric report fields in the output file.
 void setExportMode(ICharacterSeparatedValuesExportFormatOptions.ExportMode exportMode)
           Sets the ExportMode of the report.
 void setGroupSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
           Sets the group sections option of the report.
 void setPreserveDateFormatting(boolean bPreserveDateFormatting)
          Deprecated.  
 void setPreserveNumberFormatting(boolean bPreserveNumberFormatting)
          Deprecated.  
 void setReportSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
           Sets the report sections option of the report.
 void setSeparator(java.lang.String Separator)
           Sets the character that is used to separate one report field from another in the output file.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CharacterSeparatedValuesExportFormatOptions

public CharacterSeparatedValuesExportFormatOptions()

CharacterSeparatedValuesExportFormatOptions

public CharacterSeparatedValuesExportFormatOptions(ICharacterSeparatedValuesExportFormatOptions src)
Method Detail

setDelimiter

public void setDelimiter(java.lang.String Delimiter)
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets the delimiter that is used to enclose all non-numeric report fields in the output file.

When you export a report to a Separated Values (CSV) file, the program encloses all non-numeric fields in quotation marks. The recommended values for this property are either single(') or double (") quotes as they are commonly accepted by applications that can open Separated Values (CSV) files.

Any string can be used for this property but the string must be selected carefully to ensure that the application that reads the output file can do so without confusion.

Specified by:
setDelimiter in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
Delimiter - A String that specifies the delimiter.

getDelimiter

public java.lang.String getDelimiter()
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets the delimiter that is used to enclose all non-numeric report fields in the output file.

Specified by:
getDelimiter in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
A String that specifies the delimiter.

setSeparator

public void setSeparator(java.lang.String Separator)
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets the character that is used to separate one report field from another in the output file.

When you export a report to a Separated Values (CSV) file, you must specify the character to be used to separate one field from another in that file. Set this property to any keyboard character.

The recommended value for this property is a comma as it is commonly accepted by applications that can open Separated Value (CSV) files. Avoid specifying quotation marks as a separator, because they are used to surround non-numeric fields.

Specified by:
setSeparator in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
Separator - A String that specifies the keyboard character that is used as the separator.

getSeparator

public java.lang.String getSeparator()
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets the character that is used to separate one report field from another in the output file.

Specified by:
getSeparator in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
A String that specifies the keyboard character that is used as the separator.

setPreserveNumberFormatting

public void setPreserveNumberFormatting(boolean bPreserveNumberFormatting)
Deprecated. 

Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets whether the number formatting of the report is preserved when the report is exported.

Specified by:
setPreserveNumberFormatting in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
bPreserveNumberFormatting - true if the number formatting of the report is preserved when it is exported, and false otherwise.

getPreserveNumberFormatting

public boolean getPreserveNumberFormatting()
Deprecated. 

Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets whether the number formatting of the report is preserved when the report is exported.

Specified by:
getPreserveNumberFormatting in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
true if the number formatting of the report is preserved when it is exported, and false otherwise.

setPreserveDateFormatting

public void setPreserveDateFormatting(boolean bPreserveDateFormatting)
Deprecated. 

Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets whether the date formatting of the report is preserved when the report is exported.

Specified by:
setPreserveDateFormatting in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
bPreserveDateFormatting - true if the date formatting of the report is preserved when it is exported, and false otherwise.

getPreserveDateFormatting

public boolean getPreserveDateFormatting()
Deprecated. 

Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets whether the date formatting of the report is preserved when the report is exported.

Specified by:
getPreserveDateFormatting in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
true if the date formatting of the report is preserved when it is exported, and false otherwise.

getExportMode

public ICharacterSeparatedValuesExportFormatOptions.ExportMode getExportMode()
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets the ExportMode of the report.

Specified by:
getExportMode in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
The ExportMode of the report.

setExportMode

public void setExportMode(ICharacterSeparatedValuesExportFormatOptions.ExportMode exportMode)
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets the ExportMode of the report.

Specified by:
setExportMode in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
exportMode - the ExportMode of the report

getReportSectionsOption

public ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getReportSectionsOption()
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets the report sections option of the report. See ExportSectionsOption for details.

Specified by:
getReportSectionsOption in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
The ExportSectionsOption of the report.

setReportSectionsOption

public void setReportSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets the report sections option of the report. See ExportSectionsOption for details.

Specified by:
setReportSectionsOption in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
exportSectionsOptions - the ExportSectionsOption of the report

getGroupSectionsOption

public ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getGroupSectionsOption()
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Gets the group sections option of the report. See ExportSectionsOption for details.

Specified by:
getGroupSectionsOption in interface ICharacterSeparatedValuesExportFormatOptions
Returns:
The ExportSectionsOption of the report.

setGroupSectionsOption

public void setGroupSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
Description copied from interface: ICharacterSeparatedValuesExportFormatOptions

Sets the group sections option of the report. See ExportSectionsOption for details.

Specified by:
setGroupSectionsOption in interface ICharacterSeparatedValuesExportFormatOptions
Parameters:
exportSectionsOptions - the ExportSectionsOption of the report

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

checkValidity

public void checkValidity(java.util.Locale locale)
Description copied from interface: IExportFormatOptions
Verifies that the export options are valid for a given locale.

Specified by:
checkValidity in interface IExportFormatOptions
Parameters:
locale - the locale the options are being checked for

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


hasContent

public boolean hasContent(java.lang.Object obj)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 java.lang.String sTag,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer,
                         com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.