|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Field
com.crystaldecisions.sdk.occa.report.data.DBField
public class DBField
This object represents a database field.
Use the IDBField interface to manipulate this object.
| Constructor Summary | |
|---|---|
DBField()
|
|
DBField(IDBField src)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
SummaryMetadata |
getDefaultSummaryMetadata()
For internal use only |
java.lang.String |
getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
For internal use only |
boolean |
getIsRecurring()
Returns true if the field is recurring, and false otherwise. |
FieldKind |
getKind()
Returns what kind of field this is. |
java.lang.String |
getLongName(java.util.Locale locale)
Returns the fully qualified name of the field. |
java.lang.String |
getTableAlias()
Returns the alias that is used to identify the table. |
java.lang.String |
getUniqueID()
For internal use only |
boolean |
hasContent(java.lang.Object srcField)
|
boolean |
isServerAggregatable()
For internal use only |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
|
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
|
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
|
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
|
void |
setDefaultSummaryMetadata(SummaryMetadata defaultSummaryMetadata)
For internal use only |
void |
setServerAggregatable(boolean serverAggregatable)
For internal use only |
void |
setTableAlias(java.lang.String tableAlias)
Sets the alias that is used to identify the table. |
void |
setUniqueID(java.lang.String uniqueID)
For internal use only |
| Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
|---|
createMember, endElement, getAttributes, getDescription, getFormulaForm, getHeadingText, getIsPrintTime, getLength, getName, getShortName, getType, getValueTypeForFormatOption, setAttributes, setDescription, setHeadingText, setLength, setName, setType, startElement |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IDBField |
|---|
getHeadingText, setHeadingText |
| Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IField |
|---|
getDescription, getFormulaForm, getLength, getName, getShortName, getType, getValueTypeForFormatOption, setDescription, setLength, setName, setType |
| Constructor Detail |
|---|
public DBField(IDBField src)
public DBField()
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
clone in class Field
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
copyTo in class Fieldpublic boolean getIsRecurring()
IField
Returns true if the field is recurring, and false otherwise. A
field is recurring if its contents change during the formatting of a report. A constant field
(not recurring) is one that doesn't change. The special field "Page Number," for example, is
a recurring field, while the special field "Report Title" is not.
getIsRecurring in interface IFieldgetIsRecurring in class Fieldtrue if the field is recurring, and false otherwise.public FieldKind getKind()
IFieldReturns what kind of field this is. Do not confuse this property with Type. Kind identifies what sort of report field this is, while Type identifies what the field is composed of. For example, a bitmap, string, chart, number, date, and so on.
getKind in interface IFieldString that specifies what kind of field this is.public java.lang.String getLongName(java.util.Locale locale)
IFieldReturns the fully qualified name of the field.
getLongName in interface IFieldgetLongName in class Fieldlocale - The locale that will be used to localize the field.
String containing the fully qualified name of the field.public java.lang.String getTableAlias()
IDBFieldReturns the alias that is used to identify the table.
getTableAlias in interface IDBFieldString.public java.lang.String getUniqueID()
getUniqueID in interface IDBFieldpublic boolean isServerAggregatable()
IDBField
isServerAggregatable in interface IDBFieldpublic boolean hasContent(java.lang.Object srcField)
hasContent in class Field
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
readElement in class Field
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
save in class Fieldjava.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
saveContents in class Fieldjava.io.IOExceptionpublic void setTableAlias(java.lang.String tableAlias)
IDBFieldSets the alias that is used to identify the table.
setTableAlias in interface IDBFieldtableAlias - The table alias as a String.public void setUniqueID(java.lang.String uniqueID)
setUniqueID in interface IDBFielduniqueID - Unique ID of fieldpublic void setServerAggregatable(boolean serverAggregatable)
IDBField
setServerAggregatable in interface IDBFieldpublic SummaryMetadata getDefaultSummaryMetadata()
getDefaultSummaryMetadata in interface IDBFieldpublic void setDefaultSummaryMetadata(SummaryMetadata defaultSummaryMetadata)
public java.lang.String getDisplayName(FieldDisplayNameType displayName,
java.util.Locale locale)
getDisplayName in interface IFieldgetDisplayName in class FielddisplayName - Indicates how the display text should be formatted. It may be one of
the values listed under FieldDisplayNameType.locale - Formats the string according to a locale.
String containing the name of the field that has been formatted
according to the value of the parameter displayNameType.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||