/*
Copyright 2008-2010 Gephi
Authors : Mathieu Bastian <mathieu.bastian@gephi.org>
Website : http://www.gephi.org
This file is part of Gephi.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
Copyright 2011 Gephi Consortium. All rights reserved.
The contents of this file are subject to the terms of either the GNU
General Public License Version 3 only ("GPL") or the Common
Development and Distribution License("CDDL") (collectively, the
"License"). You may not use this file except in compliance with the
License. You can obtain a copy of the License at
http://gephi.org/about/legal/license-notice/
or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
specific language governing permissions and limitations under the
License. When distributing the software, include this License Header
Notice in each file and include the License files at
/cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
License Header, with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"
If you wish your version of this file to be governed by only the CDDL
or only the GPL Version 3, indicate your decision by adding
"[Contributor] elects to include this software in this distribution
under the [CDDL or GPL Version 3] license." If you do not indicate a
single choice of license, a recipient has the option to distribute
your version of this file under either the CDDL, the GPL Version 3 or
to extend the choice of license to its licensees as provided above.
However, if you add GPL Version 3 code and therefore, elected the GPL
Version 3 license, then the option applies only if the new code is
made subject to such option by the copyright holder.
Contributor(s):
Portions Copyrighted 2011 Gephi Consortium.
*/
package org.gephi.project.api;
/**
* Hosts user data about a project.
* <p>
* These information are also saved to the project file.
*
* @author Mathieu Bastian
*/
public interface ProjectMetaData {
/**
* Returns the keywords of this project.
*
* @return the project's keywords or empty string if missing
*/
public String getKeywords();
/**
* Returns the author of this project.
* <p>
* The default value is the computer's user name.
*
* @return project's author
*/
public String getAuthor();
/**
* Returns the description of this project.
*
* @return the project's description or empty string if missing
*/
public String getDescription();
/**
* Returns the title of this project.
*
* @return the project's title or empty string if missing
*/
public String getTitle();
/**
* Sets the project's author.
*
* @param author author
*/
public void setAuthor(String author);
/**
* Sets the project's description.
*
* @param description description
*/
public void setDescription(String description);
/**
* Sets the project's keywords.
*
* @param keywords keywords
*/
public void setKeywords(String keywords);
/**
* Sets the project's title.
*
* @param title title
*/
public void setTitle(String title);
}