| prefuse.data.tuple.TupleSet
All known Subclasses: prefuse.data.tuple.AbstractTupleSet,
| TupleSet | | public interface TupleSet (Code) | | A collection of data tuples. This is the top level interface for all
data collections in the prefuse framework.
author:
jeffrey heer
See Also: prefuse.data.Tuple |
| Field Summary | |
| final public static Tuple[] | EMPTY_ARRAY
An empty, zero-length array of tuples. |
| Method Summary | |
| public void | addColumn(String name, Class type)
Add a data field / column to this TupleSet's members. | | public void | addColumn(String name, Class type, Object defaultValue)
Add a data field / column to this TupleSet's members. | | public void | addColumn(String name, String expr)
Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
expr - an uncompiled expression in the prefuse expressionlanguage. | | public void | addColumn(String name, Expression expr)
Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
expr - a compiled expression in the prefuse expressionlanguage. | | public void | addColumns(Schema s)
Add the data fields of the given Schema to the Tuples in this TupleSet. | | public void | addPropertyChangeListener(PropertyChangeListener lstnr)
Add a PropertyChangeListener to be notified of changes to the properties
bounds to this TupleSet. | | public void | addPropertyChangeListener(String key, PropertyChangeListener lstnr)
Add a PropertyChangeListener to be notified of changes to a
specific property bound to this TupleSet. | | public Tuple | addTuple(Tuple t)
Add a Tuple to this TupleSet. | | public void | addTupleSetListener(TupleSetListener tsl)
Add a listener to this tuple set that will be notified when tuples
are added and removed from the set. | | public void | clear()
Clear this TupleSet, removing all contained Tuples. | | public boolean | containsTuple(Tuple t)
Indicates if a given Tuple is contained within this TupleSet. | | public Object | getClientProperty(String key)
| | public int | getTupleCount()
Get the number of tuples in this set. | | public boolean | isAddColumnSupported()
Indicates if this TupleSet supports the addition of data columns to
its contained Tuple instances. | | public void | putClientProperty(String key, Object value)
| | public void | removePropertyChangeListener(PropertyChangeListener lstnr)
Remove a PropertyChangeListener from this TupleSet. | | public void | removePropertyChangeListener(String key, PropertyChangeListener lstnr)
Remove a PropertyChangeListener from this TupleSet for a specific
bound property. | | public boolean | removeTuple(Tuple t)
Remove a Tuple from this TupleSet. | | public void | removeTupleSetListener(TupleSetListener tsl)
Remove a listener from this tuple set. | | public Tuple | setTuple(Tuple t)
Set the TupleSet contents to be a single Tuple. | | public Iterator | tuples()
Return an iterator over the tuples in this tuple set. | | public Iterator | tuples(Predicate filter)
Return an iterator over the tuples in this tuple set, filtered by
the given predicate. | | public Iterator | tuples(Predicate filter, Sort sort)
|
| EMPTY_ARRAY | | final public static Tuple[] EMPTY_ARRAY(Code) | | An empty, zero-length array of tuples.
|
| addColumn | | public void addColumn(String name, Class type)(Code) | | Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
type - the type of the data field |
| addColumn | | public void addColumn(String name, Class type, Object defaultValue)(Code) | | Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
type - the type of the data field
Parameters:
defaultValue - the defaultValue of the data field |
| addColumn | | public void addColumn(String name, String expr)(Code) | | Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
expr - an uncompiled expression in the prefuse expressionlanguage. This will be compiled to a valid expression, and theresults of applying the expression to a Tuple will become thedata field value for that Tuple.
See Also: prefuse.data.expression
See Also: prefuse.data.expression.parser.ExpressionParser |
| addColumn | | public void addColumn(String name, Expression expr)(Code) | | Add a data field / column to this TupleSet's members.
Parameters:
name - the name of the data field
Parameters:
expr - a compiled expression in the prefuse expressionlanguage. The results of applying the expression to a Tuple willbecome the data field value for that Tuple.
See Also: prefuse.data.expression |
| addColumns | | public void addColumns(Schema s)(Code) | | Add the data fields of the given Schema to the Tuples in this TupleSet.
If this TupleSet contains heterogeneous Tuples (i.e., those from
different source tables), all backing tables involved will be updated.
Parameters:
s - the Schema of data columns to add to this TupleSet |
| addPropertyChangeListener | | public void addPropertyChangeListener(PropertyChangeListener lstnr)(Code) | | Add a PropertyChangeListener to be notified of changes to the properties
bounds to this TupleSet.
Parameters:
lstnr - the PropertyChangeListener to add |
| addPropertyChangeListener | | public void addPropertyChangeListener(String key, PropertyChangeListener lstnr)(Code) | | Add a PropertyChangeListener to be notified of changes to a
specific property bound to this TupleSet.
Parameters:
key - the specific key for which to listen to properties changes
Parameters:
lstnr - the PropertyChangeListener to add |
| addTuple | | public Tuple addTuple(Tuple t)(Code) | | Add a Tuple to this TupleSet. This method is optional, and may result
in an UnsupportedOperationException on some TupleSet implementations.
Parameters:
t - the Tuple add the actual Tuple instance stored in the TupleSet. This may benull to signify that the add failed, may be a new Tuple withvalues copied from the input tuple, or may be the input Tuple itself. |
| addTupleSetListener | | public void addTupleSetListener(TupleSetListener tsl)(Code) | | Add a listener to this tuple set that will be notified when tuples
are added and removed from the set.
Parameters:
tsl - the TupleSetListener to add |
| clear | | public void clear()(Code) | | Clear this TupleSet, removing all contained Tuples.
|
| containsTuple | | public boolean containsTuple(Tuple t)(Code) | | Indicates if a given Tuple is contained within this TupleSet.
Parameters:
t - the tuple to check for containment true if the Tuple is in this TupleSet, false otherwise |
| getClientProperty | | public Object getClientProperty(String key)(Code) | | Get an client property bound to this TupleSet
Parameters:
key - the name of the property to retrieve the client property value, or null if no value wasfound for the given key. |
| getTupleCount | | public int getTupleCount()(Code) | | Get the number of tuples in this set.
the tuple count |
| isAddColumnSupported | | public boolean isAddColumnSupported()(Code) | | Indicates if this TupleSet supports the addition of data columns to
its contained Tuple instances.
true is add column operations are supported, false otherwise |
| putClientProperty | | public void putClientProperty(String key, Object value)(Code) | | Set an arbitrary client property with this TupleSet
Parameters:
key - the name of the property to set
Parameters:
value - the value of the property to use |
| removePropertyChangeListener | | public void removePropertyChangeListener(PropertyChangeListener lstnr)(Code) | | Remove a PropertyChangeListener from this TupleSet.
Parameters:
lstnr - the PropertyChangeListener to remove |
| removePropertyChangeListener | | public void removePropertyChangeListener(String key, PropertyChangeListener lstnr)(Code) | | Remove a PropertyChangeListener from this TupleSet for a specific
bound property.
Parameters:
key - the specific key for which to remove the listener
Parameters:
lstnr - the PropertyChangeListener to remove |
| removeTuple | | public boolean removeTuple(Tuple t)(Code) | | Remove a Tuple from this TupleSet.
Parameters:
t - the Tuple to remove true if the Tuple was found and removed, false otherwise |
| removeTupleSetListener | | public void removeTupleSetListener(TupleSetListener tsl)(Code) | | Remove a listener from this tuple set.
Parameters:
tsl - the TupleSetListener to remove |
| setTuple | | public Tuple setTuple(Tuple t)(Code) | | Set the TupleSet contents to be a single Tuple. This method is
optional, and may result in an UnsupportedOperationException on some
TupleSet implementations.
Parameters:
t - the Tuple to set as the content of this TupleSet the actual Tuple instance stored in the TupleSet. This may benull to signify that the add failed, may be a new Tuple withvalues copied from the input tuple, or may be the input Tuple itself. |
| tuples | | public Iterator tuples()(Code) | | Return an iterator over the tuples in this tuple set.
an iterator over this set's tuples |
| tuples | | public Iterator tuples(Predicate filter)(Code) | | Return an iterator over the tuples in this tuple set, filtered by
the given predicate.
Parameters:
filter - predicate to apply to tuples in this set, only tuplesfor which the predicate evaluates to true are included in the iteration a filtered iterator over this set's tuples |
| tuples | | public Iterator tuples(Predicate filter, Sort sort)(Code) | | Return an iterator over the tuples in this tuple set, filtered by
the given predicate
Parameters:
filter - predicate to apply to tuples in this set, only tuplesfor which the predicate evaluates to true are included in the iteration.If this value is null, no filtering will be performed.
Parameters:
sort - the sorting criteria by which to order the returned tuples a filtered, sorted iterator over this set's tuples |
|
|