RowFilter.Entry (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class RowFilter.Entry

java.lang.Object
  javax.swing.RowFilter.Entry

Enclosing class:: RowFilter

public abstract static class RowFilter.Entry
extends Object

An Entry object is passed to instances of RowFilter, allowing the filter to get the value of the entry's data, and thus to determine whether the entry should be shown. An Entry object contains information about the model as well as methods for getting the underlying values from the model.

Constructor Summary
`RowFilter.Entry()` Creates an `Entry`.

Method Summary
`abstract Object`	`getIdentifier()` Returns the identifer (in the model) of the entry.
`abstract Object`	`getModel()` Returns the underlying model.
`String`	`getStringValue(int index)` Returns the string value at the specified index.
`abstract Object`	`getValue(int index)` Returns the value at the specified index.
`abstract int`	`getValueCount()` Returns the number of values in the entry.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RowFilter.Entry

public RowFilter.Entry()

Creates an Entry.

Method Detail

getIdentifier

public abstract Object getIdentifier()

Returns the identifer (in the model) of the entry. For a table this corresponds to the index of the row in the model, expressed as an Integer.

Returns:: a model-based (not view-based) identifier for this entry

getModel

public abstract Object getModel()

Returns the underlying model.

Returns:: the model containing the data that this entry represents

getStringValue

public String getStringValue(int index)

Returns the string value at the specified index. If filtering is being done based on String values this method is preferred to that of getValue as getValue(index).toString() may return a different result than getStringValue(index).

This implementation calls getValue(index).toString() after checking for null. Subclasses that provide different string conversion should override this method if necessary.

Parameters:: index - the index of the value to get
Returns:: {@code non-null} string at the specified index

getValue

public abstract Object getValue(int index)

Returns the value at the specified index. This may return null. When used with a table, index corresponds to the column number in the model.

Parameters:: index - the index of the value to get
Returns:: value at the specified index

getValueCount

public abstract int getValueCount()

Returns the number of values in the entry. For example, when used with a table this corresponds to the number of columns.

Returns:: number of values in the object being filtered