com.crystaldecisions.sdk.occa.report.definition
Class DateFieldFormat

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.DateFieldFormat
All Implemented Interfaces:
IDateFieldFormat, IClone

public class DateFieldFormat
extends java.lang.Object
implements IDateFieldFormat, IClone

This object is used to specify the format of the date field or the date part of the DateTimeField in the report object. You can specify properties such as the calendar type, the date, month, and year format, and the order in which the date elements appear. When possible, use the IDateFieldFormat interface.


Constructor Summary
DateFieldFormat()
           
DateFieldFormat(IDateFieldFormat src)
           
DateFieldFormat(java.util.Locale locale)
           
 
Method Summary
 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, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 DateCalendarType getCalendarType()
          Returns the calendar type for the date field.
 DateFieldFormatConditionFormulas getConditionFormulas()
          Returns the condition formulas used to override the date field's format settings.
 ControllableMixin getControllableMixin()
           
 java.lang.String getDateFirstSeparator()
          Returns the first separator which separates the date elements.
 DateOrder getDateOrder()
          Returns the order in which the date elements will appear.
 java.lang.String getDatePrefixSeparator()
          Returns the prefix for the date.
 java.lang.String getDateSecondSeparator()
          Returns the second separator which separates the date elements.
 java.lang.String getDateSuffixSeparator()
          Returns the suffix for the date.
 DayFormat getDayFormat()
          Returns the format for displaying the day in the date.
 DayOfWeekEnclosure getDayOfWeekEnclosure()
          Gets the enclosing characters for the name of the day of the week.
 DayOfWeekPosition getDayOfWeekPosition()
          Returns where the name of the day appears.
 java.lang.String getDayOfWeekSeparator()
          Returns the separator which is inserted between the name of the day and the date.
 DayOfWeekType getDayOfWeekType()
          Returns the format for displaying the name of the day.
 DateEraType getEraType()
          Returns the format for displaying the era or period in the date.
 MonthFormat getMonthFormat()
          Returns the format for displaying the month in the date.
 DateSystemDefaultType getSystemDefaultType()
          Returns whether or not to use the default system date format.
 YearFormat getYearFormat()
          Returns the format for displaying the year in the date.
 boolean hasContent(java.lang.Object srcDateFieldFormat)
           
 boolean isDirectlyControllable()
           
 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(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
           For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void setCalendarType(DateCalendarType calendarType)
          Sets the calendar type for the date field.
 void setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)
          Sets the condition formulas used to override the date field's format settings.
 void setDateFirstSeparator(java.lang.String dateFirstSeparator)
          Sets the first separator which separates the date elements.
 void setDateOrder(DateOrder dateOrder)
          Sets the order in which the date elements will appear.
 void setDatePrefixSeparator(java.lang.String datePrefixSeparator)
          Sets the prefix for the date.
 void setDateSecondSeparator(java.lang.String dateSecondSeparator)
          Sets the second separator that separates the date elements.
 void setDateSuffixSeparator(java.lang.String dateSuffixSeparator)
          Sets the suffix for the date.
 void setDayFormat(DayFormat dayFormat)
          Sets the format for displaying the day in the date.
 void setDayOfWeekEnclosure(DayOfWeekEnclosure dayOfWeekEnclosure)
          Sets the enclosing characters for the name of the day of the week.
 void setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)
          Sets where the name of the day appears.
 void setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)
          Sets the separator that is inserted between the name of the day and the date.
 void setDayOfWeekType(DayOfWeekType dayOfWeekType)
          Sets the format for displaying the name of the day.
 void setEraType(DateEraType eraType)
          Sets the format for displaying the era or period in the date.
 void setMonthFormat(MonthFormat monthFormat)
          Sets the format for displaying the month in the date.
 void setSystemDefaultType(DateSystemDefaultType systemDefaultType)
          Sets whether or not to use the default system date format.
 void setYearFormat(YearFormat yearFormat)
          Sets the format for displaying the year in the date.
 boolean skipWritingIdenticalObject()
           For internal use only.
 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

DateFieldFormat

public DateFieldFormat(IDateFieldFormat src)

DateFieldFormat

public DateFieldFormat()

DateFieldFormat

public DateFieldFormat(java.util.Locale locale)
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

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

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     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.


getCalendarType

public DateCalendarType getCalendarType()
Description copied from interface: IDateFieldFormat
Returns the calendar type for the date field.

Specified by:
getCalendarType in interface IDateFieldFormat
Returns:
A DateCalendarType object that specifies the calendar type for the date field.

getConditionFormulas

public DateFieldFormatConditionFormulas getConditionFormulas()
Description copied from interface: IDateFieldFormat
Returns the condition formulas used to override the date field's format settings.

Specified by:
getConditionFormulas in interface IDateFieldFormat
Returns:
A DateFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

getDateFirstSeparator

public java.lang.String getDateFirstSeparator()
Description copied from interface: IDateFieldFormat
Returns the first separator which separates the date elements.

Specified by:
getDateFirstSeparator in interface IDateFieldFormat
Returns:
A String that specifies the first separator which separates the date elements.

getDateOrder

public DateOrder getDateOrder()
Description copied from interface: IDateFieldFormat
Returns the order in which the date elements will appear.

Specified by:
getDateOrder in interface IDateFieldFormat
Returns:
A DateOrder object that specifies the order in which the date elements will appear.

getDatePrefixSeparator

public java.lang.String getDatePrefixSeparator()
Description copied from interface: IDateFieldFormat
Returns the prefix for the date.

Specified by:
getDatePrefixSeparator in interface IDateFieldFormat
Returns:
A String that specifies the prefix for the date.

getDateSecondSeparator

public java.lang.String getDateSecondSeparator()
Description copied from interface: IDateFieldFormat
Returns the second separator which separates the date elements.

Specified by:
getDateSecondSeparator in interface IDateFieldFormat
Returns:
A String that specifies the second separator which separates the date elements.

getDateSuffixSeparator

public java.lang.String getDateSuffixSeparator()
Description copied from interface: IDateFieldFormat
Returns the suffix for the date.

Specified by:
getDateSuffixSeparator in interface IDateFieldFormat
Returns:
A String that specifies the suffix for the date.

getDayFormat

public DayFormat getDayFormat()
Description copied from interface: IDateFieldFormat
Returns the format for displaying the day in the date.

Specified by:
getDayFormat in interface IDateFieldFormat
Returns:
A DayFormat object that specifies the format for displaying the day in the date.

getDayOfWeekPosition

public DayOfWeekPosition getDayOfWeekPosition()
Description copied from interface: IDateFieldFormat
Returns where the name of the day appears.

Specified by:
getDayOfWeekPosition in interface IDateFieldFormat
Returns:
A DayOfWeekPosition object that specifies where the name of the day appears.

getDayOfWeekEnclosure

public DayOfWeekEnclosure getDayOfWeekEnclosure()
Description copied from interface: IDateFieldFormat
Gets the enclosing characters for the name of the day of the week.

Specified by:
getDayOfWeekEnclosure in interface IDateFieldFormat
Returns:
A DayOfWeekEnclosure that describes the enclosing characters to be used.

getDayOfWeekSeparator

public java.lang.String getDayOfWeekSeparator()
Description copied from interface: IDateFieldFormat
Returns the separator which is inserted between the name of the day and the date.

Specified by:
getDayOfWeekSeparator in interface IDateFieldFormat
Returns:
A String that specifies the separator which is inserted between the name of the day and the date.

getDayOfWeekType

public DayOfWeekType getDayOfWeekType()
Description copied from interface: IDateFieldFormat
Returns the format for displaying the name of the day.

Specified by:
getDayOfWeekType in interface IDateFieldFormat
Returns:
A DayOfWeekType object that specifies the format for displaying the name of the day.

getEraType

public DateEraType getEraType()
Description copied from interface: IDateFieldFormat
Returns the format for displaying the era or period in the date.

Specified by:
getEraType in interface IDateFieldFormat
Returns:
A DateEraType object that specifies the format for displaying the era or period in the date.

getMonthFormat

public MonthFormat getMonthFormat()
Description copied from interface: IDateFieldFormat
Returns the format for displaying the month in the date.

Specified by:
getMonthFormat in interface IDateFieldFormat
Returns:
A MonthFormat object that specifies the format for displaying the month in the date.

getSystemDefaultType

public DateSystemDefaultType getSystemDefaultType()
Description copied from interface: IDateFieldFormat
Returns whether or not to use the default system date format.

Specified by:
getSystemDefaultType in interface IDateFieldFormat
Returns:
A DateSystemDefaultType object that specifies whether or not to use the default system date format.

getYearFormat

public YearFormat getYearFormat()
Description copied from interface: IDateFieldFormat
Returns the format for displaying the year in the date.

Specified by:
getYearFormat in interface IDateFieldFormat
Returns:
A YearFormat object that specifies the format for displaying the year in the date.

hasContent

public boolean hasContent(java.lang.Object srcDateFieldFormat)

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(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setCalendarType

public void setCalendarType(DateCalendarType calendarType)
Description copied from interface: IDateFieldFormat
Sets the calendar type for the date field.

Specified by:
setCalendarType in interface IDateFieldFormat
Parameters:
calendarType - A DateCalendarType object that specifies the calendar type for the date field.

setConditionFormulas

public void setConditionFormulas(DateFieldFormatConditionFormulas conditionFormulas)
Description copied from interface: IDateFieldFormat
Sets the condition formulas used to override the date field's format settings.

Specified by:
setConditionFormulas in interface IDateFieldFormat
Parameters:
conditionFormulas - A DateFieldFormatConditionFormulas object containing the condition formulas used to override the date field's format settings.

setDateFirstSeparator

public void setDateFirstSeparator(java.lang.String dateFirstSeparator)
Description copied from interface: IDateFieldFormat
Sets the first separator which separates the date elements.

Specified by:
setDateFirstSeparator in interface IDateFieldFormat
Parameters:
dateFirstSeparator - A String that specifies the first separator which separates the date elements.

setDateOrder

public void setDateOrder(DateOrder dateOrder)
Description copied from interface: IDateFieldFormat
Sets the order in which the date elements will appear.

Specified by:
setDateOrder in interface IDateFieldFormat
Parameters:
dateOrder - A DateOrder object that specifies the order in which the date elements will appear.

setDatePrefixSeparator

public void setDatePrefixSeparator(java.lang.String datePrefixSeparator)
Description copied from interface: IDateFieldFormat
Sets the prefix for the date.

Specified by:
setDatePrefixSeparator in interface IDateFieldFormat
Parameters:
datePrefixSeparator - A String that specifies the prefix for the date.

setDateSecondSeparator

public void setDateSecondSeparator(java.lang.String dateSecondSeparator)
Description copied from interface: IDateFieldFormat
Sets the second separator that separates the date elements.

Specified by:
setDateSecondSeparator in interface IDateFieldFormat
Parameters:
dateSecondSeparator - A String that specifies the second separator that separates the date elements.

setDateSuffixSeparator

public void setDateSuffixSeparator(java.lang.String dateSuffixSeparator)
Description copied from interface: IDateFieldFormat
Sets the suffix for the date.

Specified by:
setDateSuffixSeparator in interface IDateFieldFormat
Parameters:
dateSuffixSeparator - A String that specifies the suffix for the date.

setDayFormat

public void setDayFormat(DayFormat dayFormat)
Description copied from interface: IDateFieldFormat
Sets the format for displaying the day in the date.

Specified by:
setDayFormat in interface IDateFieldFormat
Parameters:
dayFormat - A DayFormat object that specifies the format for displaying the day in the date.

setDayOfWeekEnclosure

public void setDayOfWeekEnclosure(DayOfWeekEnclosure dayOfWeekEnclosure)
Description copied from interface: IDateFieldFormat
Sets the enclosing characters for the name of the day of the week.

Specified by:
setDayOfWeekEnclosure in interface IDateFieldFormat
Parameters:
dayOfWeekEnclosure - A DayOfWeekEnclosure that describes the enclosing character to use.

setDayOfWeekPosition

public void setDayOfWeekPosition(DayOfWeekPosition dayOfWeekPosition)
Description copied from interface: IDateFieldFormat
Sets where the name of the day appears.

Specified by:
setDayOfWeekPosition in interface IDateFieldFormat
Parameters:
dayOfWeekPosition - A DayOfWeekPosition object that specifies where the name of the day appears.

setDayOfWeekSeparator

public void setDayOfWeekSeparator(java.lang.String dayOfWeekSeparator)
Description copied from interface: IDateFieldFormat
Sets the separator that is inserted between the name of the day and the date.

Specified by:
setDayOfWeekSeparator in interface IDateFieldFormat
Parameters:
dayOfWeekSeparator - A String that specifies the separator that is inserted between the name of the day and the date.

setDayOfWeekType

public void setDayOfWeekType(DayOfWeekType dayOfWeekType)
Description copied from interface: IDateFieldFormat
Sets the format for displaying the name of the day.

Specified by:
setDayOfWeekType in interface IDateFieldFormat
Parameters:
dayOfWeekType - A DayOfWeekType object that specifies the format for displaying the name of the day.

setEraType

public void setEraType(DateEraType eraType)
Description copied from interface: IDateFieldFormat
Sets the format for displaying the era or period in the date.

Specified by:
setEraType in interface IDateFieldFormat
Parameters:
eraType - A DateEraType object that specifies the format for displaying the era or period in the date.

setMonthFormat

public void setMonthFormat(MonthFormat monthFormat)
Description copied from interface: IDateFieldFormat
Sets the format for displaying the month in the date.

Specified by:
setMonthFormat in interface IDateFieldFormat
Parameters:
monthFormat - A MonthFormat object that specifies the format for displaying the month in the date.

setSystemDefaultType

public void setSystemDefaultType(DateSystemDefaultType systemDefaultType)
Description copied from interface: IDateFieldFormat
Sets whether or not to use the default system date format.

Specified by:
setSystemDefaultType in interface IDateFieldFormat
Parameters:
systemDefaultType - A DateSystemDefaultType object that specifies whether or not to use the default system date format.

setYearFormat

public void setYearFormat(YearFormat yearFormat)
Description copied from interface: IDateFieldFormat
Sets the format for displaying the year in the date.

Specified by:
setYearFormat in interface IDateFieldFormat
Parameters:
yearFormat - A YearFormat object that specifies the format for displaying the year in the date.

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

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

For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()