|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.datacrow.core.data.DataFilter
public class DataFilter
Used to filter for items.
A filter is created out of filter entries (see DataFilterEntry
).
Filters can be saved to a file for reuse. Filters are used on the web as well as in
the normal GUI.
Field Summary | |
---|---|
static int |
_SORTORDER_ASCENDING
|
static int |
_SORTORDER_DESCENDING
|
Constructor Summary | |
---|---|
DataFilter(DcObject dco)
Creates a filter based on the supplied item. |
|
DataFilter(int module)
Creates an empty filter for a specific module. |
|
DataFilter(int module,
java.util.Collection<DataFilterEntry> entries)
Creates a filter using the supplied entries. |
|
DataFilter(java.lang.String xml)
Creates a filter based on an xml definition. |
Method Summary | |
---|---|
void |
addEntry(DataFilterEntry entry)
Adds a single entry to this filter. |
boolean |
equals(DataFilter df)
|
boolean |
equals(java.lang.Object o)
|
java.util.Collection<DataFilterEntry> |
getEntries()
Returns all entries belonging to this filter. |
int |
getModule()
Returns the module for which this filter has been created. |
java.lang.String |
getName()
Returns the name of this filter. |
DcField[] |
getOrder()
Returns the order information. |
int |
getSortOrder()
|
int |
hashCode()
|
void |
setEntries(java.util.Collection<DataFilterEntry> entries)
Sets the entries for this filter. |
void |
setEntries(DcObject dco)
Sets the entries based on the supplied item. |
void |
setName(java.lang.String name)
Set the name of this filter. |
void |
setOrder(DcField[] order)
Sets the order. |
void |
setOrder(java.lang.String[] s)
Sets the order. |
void |
setSortOrder(int sortOrder)
|
java.lang.String |
toSQL(int[] fields,
boolean order,
boolean includeMod)
|
java.lang.String |
toSQLFlatStructure(int[] fields)
Creates an entirely flat structure of the data |
java.lang.String |
toStorageString()
Creates a xml definition for this filter. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int _SORTORDER_ASCENDING
public static final int _SORTORDER_DESCENDING
Constructor Detail |
---|
public DataFilter(DcObject dco)
dco
- public DataFilter(java.lang.String xml) throws java.lang.Exception
xml
-
java.lang.Exception
public DataFilter(int module)
module
- public DataFilter(int module, java.util.Collection<DataFilterEntry> entries)
module
- entries
- Method Detail |
---|
public int getSortOrder()
public void setOrder(java.lang.String[] s)
s
- Array of field names (column names).public void setSortOrder(int sortOrder)
public void setOrder(DcField[] order)
order
- Array of fields.public void addEntry(DataFilterEntry entry)
entry
- public void setEntries(java.util.Collection<DataFilterEntry> entries)
entries
- public java.util.Collection<DataFilterEntry> getEntries()
public void setEntries(DcObject dco)
dco
- public DcField[] getOrder()
public java.lang.String getName()
public void setName(java.lang.String name)
name
- public int getModule()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.String toStorageString()
public java.lang.String toSQLFlatStructure(int[] fields)
fields
- order
-
public java.lang.String toSQL(int[] fields, boolean order, boolean includeMod)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(DataFilter df)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |