com.flexive.shared.search
Class ResultColumnInfo

java.lang.Object
  extended by com.flexive.shared.search.ResultColumnInfo
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ResultOrderByInfo

public class ResultColumnInfo
extends java.lang.Object
implements java.io.Serializable

A displayed column info object for the result preferences.

Version:
$Rev: 677 $
Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
See Also:
Serialized Form

Constructor Summary
ResultColumnInfo(java.lang.String propertyName)
          Create a displayed column info object for a content property.
ResultColumnInfo(Table table, java.lang.String propertyName, java.lang.String suffix)
          Create a displayed column info object.
 
Method Summary
 boolean equals(java.lang.Object o)
          
 java.lang.String getColumnName()
          Return the full column name to be used in SQL queries.
 java.lang.String getLabel(FxEnvironment environment)
          Returns the label to be used e.g.
 java.lang.String getPropertyName()
           
 java.lang.String getSuffix()
           
 Table getTable()
           
 int hashCode()
          
 boolean isStructureNode()
          Return true if the object info's property is a "real" structure property or assignment.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResultColumnInfo

public ResultColumnInfo(Table table,
                        java.lang.String propertyName,
                        java.lang.String suffix)
Create a displayed column info object.

Parameters:
table - the table containing the type/assignment
propertyName - the property name or an assignment reference (#type/assignment)
suffix - an (optional) suffix

ResultColumnInfo

public ResultColumnInfo(java.lang.String propertyName)
Create a displayed column info object for a content property.

Parameters:
propertyName - the property name or an assignment reference (#type/assignment)
Method Detail

getTable

public Table getTable()

getPropertyName

public java.lang.String getPropertyName()

getSuffix

public java.lang.String getSuffix()

getLabel

public java.lang.String getLabel(FxEnvironment environment)
Returns the label to be used e.g. as result column header.

Parameters:
environment - the current environment
Returns:
the label to be used e.g. as result column header.

getColumnName

public java.lang.String getColumnName()
Return the full column name to be used in SQL queries. For example:
new ColumnInfo(Table.CONTENT, "mandator", "name").getColumnName() -> mandator.name

Returns:
the full column name to be used in SQL queries.

isStructureNode

public boolean isStructureNode()
Return true if the object info's property is a "real" structure property or assignment.

Returns:
true if this info object is for a "real" structure property or assignment

equals

public boolean equals(java.lang.Object o)

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object