|
|||||||||
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)
|
void |
doControllerModification(java.lang.Object newObject)
|
void |
enumerateMembers(IMemberVisitor visitor)
|
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. |
boolean |
hasContent(java.lang.Object srcField)
|
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(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(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setTableAlias(java.lang.String tableAlias)
Sets the alias that is used to identify the table. |
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Field |
---|
createMember, endElement, getAttributes, getControllableMixin, getDescription, getDisplayName, getFormulaForm, getHeadingText, getIsPrintTime, getLength, getName, getShortName, getType, 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, getDisplayName, getFormulaForm, getLength, getName, getShortName, getType, 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 Field
public 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 IField
getIsRecurring
in class Field
true
if the field is recurring, and false
otherwise.public FieldKind getKind()
IField
Returns 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 IField
String
that specifies what kind of field this is.public java.lang.String getLongName(java.util.Locale locale)
IField
Returns the fully qualified name of the field.
getLongName
in interface IField
getLongName
in class Field
locale
- The locale that will be used to localize the field.
String
containing the fully qualified name of the field.public java.lang.String getTableAlias()
IDBField
Returns the alias that is used to identify the table.
getTableAlias
in interface IDBField
String
.public 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)
Field
For internal use only.
readElement
in class Field
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
Field
For internal use only.
save
in class Field
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
Field
For internal use only.
save
in class Field
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
Field
For internal use only.
saveContents
in class Field
java.io.IOException
public void setTableAlias(java.lang.String tableAlias)
IDBField
Sets the alias that is used to identify the table.
setTableAlias
in interface IDBField
tableAlias
- The table alias as a String
.public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |