net.sf.jtables.table.AnnotatedTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jtables Show documentation

Simple and lightweight framework to work with tables and table based files such as CSV and other (tab)-delimited files.

There is a newer version: 2.2.2

/**********************************************************************
Copyright (c) 2009-2010 Alexander Kerner. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 ***********************************************************************/

package net.sf.jtables.table;

import java.util.List;
import java.util.NoSuchElementException;
import java.util.Set;

/**
 * 
 * A {@code AnnotatedTable} extends {@link Table} by providing object
 * identifiers for rows and columns. 

 * This makes it possible to access rows and columns not only by their integer
 * index, but also by an additional object mapping.
 * 
 * 
 * Example:

 * 
 * 
 * 
 * 
 * 
 * TODO example
 * 
 * 
 * 
 * 
 * @author Alexander Kerner
 * @version 2010-12-04
 * 
 * @param 
 *            type of elements in table
 */
public interface AnnotatedTable extends Table {

	/**
	 * 
	 * Set identifiers for columns.
	 *
	 * @param ids a {@link java.util.Set Set} that contains all column identifiers
	 */
	void setColumnIdentifier(Set ids);

	/**
	 * 
	 * Set identifiers for rows.
	 *
	 * @param ids a {@link java.util.Set Set} that contains all row identifiers
	 */
	void setRowIdentifier(Set ids);

	/**
	 * 
	 * Retrieve a {@link java.util.Set Set} that contains all row identifiers. 
	 *
	 * @return all row identifiers
	 */
	Set