|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.exportoptions.CharacterSeparatedValuesExportFormatOptions
public class CharacterSeparatedValuesExportFormatOptions
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 |
---|
public CharacterSeparatedValuesExportFormatOptions()
public CharacterSeparatedValuesExportFormatOptions(ICharacterSeparatedValuesExportFormatOptions src)
Method Detail |
---|
public void setDelimiter(java.lang.String Delimiter)
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.
setDelimiter
in interface ICharacterSeparatedValuesExportFormatOptions
Delimiter
- A String
that specifies the delimiter.public java.lang.String getDelimiter()
ICharacterSeparatedValuesExportFormatOptions
Gets the delimiter that is used to enclose all non-numeric report fields in the output file.
getDelimiter
in interface ICharacterSeparatedValuesExportFormatOptions
String
that specifies the delimiter.public void setSeparator(java.lang.String Separator)
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.
setSeparator
in interface ICharacterSeparatedValuesExportFormatOptions
Separator
- A String
that specifies the keyboard character that is used as the separator.public java.lang.String getSeparator()
ICharacterSeparatedValuesExportFormatOptions
Gets the character that is used to separate one report field from another in the output file.
getSeparator
in interface ICharacterSeparatedValuesExportFormatOptions
String
that specifies the keyboard character that is used as the separator.public void setPreserveNumberFormatting(boolean bPreserveNumberFormatting)
ICharacterSeparatedValuesExportFormatOptions
Sets whether the number formatting of the report is preserved when the report is exported.
setPreserveNumberFormatting
in interface ICharacterSeparatedValuesExportFormatOptions
bPreserveNumberFormatting
- true
if the number formatting of the report is preserved when it is exported, and false
otherwise.public boolean getPreserveNumberFormatting()
ICharacterSeparatedValuesExportFormatOptions
Gets whether the number formatting of the report is preserved when the report is exported.
getPreserveNumberFormatting
in interface ICharacterSeparatedValuesExportFormatOptions
true
if the number formatting of the report is preserved when it is exported, and false
otherwise.public void setPreserveDateFormatting(boolean bPreserveDateFormatting)
ICharacterSeparatedValuesExportFormatOptions
Sets whether the date formatting of the report is preserved when the report is exported.
setPreserveDateFormatting
in interface ICharacterSeparatedValuesExportFormatOptions
bPreserveDateFormatting
- true
if the date formatting of the report is preserved when it is exported, and false
otherwise.public boolean getPreserveDateFormatting()
ICharacterSeparatedValuesExportFormatOptions
Gets whether the date formatting of the report is preserved when the report is exported.
getPreserveDateFormatting
in interface ICharacterSeparatedValuesExportFormatOptions
true
if the date formatting of the report is preserved when it is exported, and false
otherwise.public ICharacterSeparatedValuesExportFormatOptions.ExportMode getExportMode()
ICharacterSeparatedValuesExportFormatOptions
Gets the ExportMode
of the report.
getExportMode
in interface ICharacterSeparatedValuesExportFormatOptions
ExportMode
of the report.public void setExportMode(ICharacterSeparatedValuesExportFormatOptions.ExportMode exportMode)
ICharacterSeparatedValuesExportFormatOptions
Sets the ExportMode
of the report.
setExportMode
in interface ICharacterSeparatedValuesExportFormatOptions
exportMode
- the ExportMode
of the reportpublic ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getReportSectionsOption()
ICharacterSeparatedValuesExportFormatOptions
Gets the report sections option of the report. See
ExportSectionsOption
for details.
getReportSectionsOption
in interface ICharacterSeparatedValuesExportFormatOptions
ExportSectionsOption
of the report.public void setReportSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
ICharacterSeparatedValuesExportFormatOptions
Sets the report sections option of the report. See
ExportSectionsOption
for details.
setReportSectionsOption
in interface ICharacterSeparatedValuesExportFormatOptions
exportSectionsOptions
- the ExportSectionsOption
of the reportpublic ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption getGroupSectionsOption()
ICharacterSeparatedValuesExportFormatOptions
Gets the group sections option of the report. See
ExportSectionsOption
for details.
getGroupSectionsOption
in interface ICharacterSeparatedValuesExportFormatOptions
ExportSectionsOption
of the report.public void setGroupSectionsOption(ICharacterSeparatedValuesExportFormatOptions.ExportSectionsOption exportSectionsOptions)
ICharacterSeparatedValuesExportFormatOptions
Sets the group sections option of the report. See
ExportSectionsOption
for details.
setGroupSectionsOption
in interface ICharacterSeparatedValuesExportFormatOptions
exportSectionsOptions
- the ExportSectionsOption
of the reportpublic java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public void checkValidity(java.util.Locale locale)
IExportFormatOptions
checkValidity
in interface IExportFormatOptions
locale
- the locale the options are being checked forpublic 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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public boolean hasContent(java.lang.Object obj)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
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.
java.io.IOException
public void saveContents(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |