|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.apelon.modules.dts.editor.tql.beans.TQLField
public class TQLField
A TQL Field object - used in both selector and export fields. Represents a (possibly extended) DTS Attribute and/or Function.
Copyright (c) 2009 Apelon, Inc. All rights reserved.
Constructor Summary | |
---|---|
TQLField(QualifiedObject obj)
Constructs an attribute-based TQLField from a QualifiedObject . |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Return whether the object argument represents the same TQLField as this field. |
QualifiedObject |
getAttribute()
Return the QualifiedObject attribute associated with this field. |
QualifiedObject |
getDisplay()
If this field has a display object, return the display QualifiedObject . |
QualifiedObject |
getEncode()
If this field is encoded, return the encode QualifiedObject . |
int |
getEncodeNamespaceId()
If this field is encoded, return the Namespace Id of the encode object. |
TQLFunction |
getFunction()
If this field represents a function, return the TQLFunction object. |
java.lang.String |
getLabelString()
Return a descriptive string for this field appropriate for a label or header. |
QualifiedObject |
getModifier()
If this field is modified, return the modifier QualifiedObject . |
java.lang.String |
getParameter()
If this field is from a CONSTRAIN statement, return the name of the associated parameter. |
boolean |
isEncoded()
Return whether the field is encoded. |
boolean |
isFunction()
Return whether the field is a function. |
boolean |
isModified()
Return whether the field is modified. |
void |
setAttribute(QualifiedObject attribute)
Set the value of the field's primary QualifiedObject attribute. |
void |
setDisplay(QualifiedObject display)
Set the value of the field's display QualifiedObject . |
void |
setEncode(QualifiedObject encode)
Set the value of the field's encode QualifiedObject . |
void |
setEncodeNamespaceId(int encodeId)
Set the Namespace Id value of the field's encode object. |
void |
setFunction(TQLFunction function)
Set the value of the field's function. |
void |
setModifier(QualifiedObject modifier)
Set the value of the field's modify QualifiedObject . |
void |
setParameter(java.lang.String name)
Set the name of the parameter associated with this field. |
java.lang.String |
toString()
Return a string representation of this TQLField . |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TQLField(QualifiedObject obj)
TQLField
from a QualifiedObject
.
obj
- the primary attribute objectMethod Detail |
---|
public QualifiedObject getAttribute()
QualifiedObject
attribute associated with this field.
QualifiedObject
public void setAttribute(QualifiedObject attribute)
QualifiedObject
attribute.
attribute
- the field's attribute objectpublic QualifiedObject getEncode()
QualifiedObject
.
public void setEncode(QualifiedObject encode)
QualifiedObject
.
encode
- the field's encode objectpublic int getEncodeNamespaceId()
public void setEncodeNamespaceId(int encodeId)
encodeId
- the Namespace Id of the field's encode objectpublic boolean isEncoded()
public QualifiedObject getModifier()
QualifiedObject
.
public void setModifier(QualifiedObject modifier)
QualifiedObject
.
modifier
- the field's modify objectpublic boolean isModified()
public QualifiedObject getDisplay()
QualifiedObject
.
public void setDisplay(QualifiedObject display)
QualifiedObject
.
display
- the field's display objectpublic TQLFunction getFunction()
TQLFunction
object.
public void setFunction(TQLFunction function)
function
- the field's function objectpublic boolean isFunction()
public java.lang.String getParameter()
CONSTRAIN
statement, return the name of the associated parameter.
public void setParameter(java.lang.String name)
name
- the name of the field's parameterpublic java.lang.String getLabelString()
public boolean equals(java.lang.Object obj)
TQLField
as this field.
All attributes are tested with their counterparts using equals
.
equals
in class java.lang.Object
public java.lang.String toString()
TQLField
.
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |