BookmarkList.java

/*******************************************************************************
 * Copyright 2012 Geoscience Australia
 * 
 * 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 au.gov.ga.earthsci.bookmark.model;

import java.util.List;
import java.util.UUID;

import org.eclipse.core.databinding.observable.list.IListChangeListener;
import org.eclipse.core.databinding.observable.list.ListChangeEvent;
import org.eclipse.core.databinding.observable.list.WritableList;

import au.gov.ga.earthsci.common.persistence.Exportable;
import au.gov.ga.earthsci.common.persistence.Persistent;
import au.gov.ga.earthsci.common.util.AbstractPropertyChangeBean;

/**
 * The default {@link IBookmarkList} implementation
 * 
 * @author James Navin (james.navin@ga.gov.au)
 */
@Exportable
public class BookmarkList extends AbstractPropertyChangeBean implements IBookmarkList
{
	@Persistent(attribute = true)
	private String id;

	@Persistent
	private String name;

	private WritableList bookmarks;

	/**
	 * Create a new unnamed bookmark list with a unique randome ID.
	 */
	public BookmarkList()
	{
		this.id = UUID.randomUUID().toString();

		doSetBookmarks(new WritableList());
	}

	/**
	 * Create a new bookmark list with the given name and a unique random ID.
	 */
	public BookmarkList(String name)
	{
		this();
		this.name = name;
	}

	/**
	 * Create a new bookmark list with the given name and ID.
	 */
	public BookmarkList(String id, String name)
	{
		this();
		this.id = id;
		this.name = name;
	}

	@Override
	public String getId()
	{
		return id;
	}

	public void setId(String id)
	{
		firePropertyChange("id", this.id, this.id = id); //$NON-NLS-1$
	}

	@Override
	public String getName()
	{
		return name;
	}

	@Override
	public void setName(String name)
	{
		firePropertyChange("name", this.name, this.name = name); //$NON-NLS-1$
	}

	@SuppressWarnings("unchecked")
	@Override
	@Persistent
	public List<IBookmark> getBookmarks()
	{
		return bookmarks;
	}

	@Override
	public void setBookmarks(List<IBookmark> bookmarks)
	{
		WritableList oldList = this.bookmarks;

		WritableList newList = new WritableList();
		newList.addAll(bookmarks);

		doSetBookmarks(newList);

		firePropertyChange("bookmarks", oldList, this.bookmarks); //$NON-NLS-1$
	}

	private void doSetBookmarks(WritableList newBookmarks)
	{
		if (newBookmarks == this.bookmarks)
		{
			return;
		}

		this.bookmarks = newBookmarks;
		this.bookmarks.addListChangeListener(new IListChangeListener()
		{
			@Override
			public void handleListChange(ListChangeEvent event)
			{
				firePropertyChange("bookmarks", null, bookmarks); //$NON-NLS-1$
			}
		});
	}

}