/*
    * This file is a part of CAST project.
    * (c) Copyright 2007, AGH University of Science & Technology
    * https://caribou.iisg.agh.edu.pl/trac/cast
    *
    * Licensed under the Eclipse Public License, Version 1.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.eclipse.org/legal/epl-v10.html
   */
  /*
   * File: IVisualResourceEntry.java
   * Created: 2009-07-17
   * Author: kpietak
   * $Id$
   */
  
  package pl.edu.agh.cast.resource;
  
  import java.util.List;
  
  import org.eclipse.jface.resource.ResourceRegistry;
  
  import pl.edu.agh.cast.data.model.Type;
  
  /**
   * A class which holds all data needed to create a visual resource. The entry is provided by
   * {@link IVisualResourcesProvider} and processed in {@link ResourceRegistry#register} method.
   * 
   * @see IVisualResource
   * @author AGH CAST Team
   */
  public class VisualResourceEntry {
  
  	// BEGIN CODE - image extensions definition
  
  	/**
  	 * Image file type PNG.
  	 */
  	public static final String RESOURCE_EXTENSION_PNG = "png"; //$NON-NLS-1$
  
  	/**
  	 * Image file type BMP.
  	 */
  	public static final String RESOURCE_EXTENSION_BMP = "bmp"; //$NON-NLS-1$
  
  	/**
  	 * Image file type GIF.
  	 */
  	public static final String RESOURCE_EXTENSION_GIF = "gif"; //$NON-NLS-1$
  
  	/**
  	 * Image file type ICO.
  	 */
  	public static final String RESOURCE_EXTENSION_ICO = "ico"; //$NON-NLS-1$
  
  	// END CODE - image extensions definition
  
  	/**
  	 * Resource id.
  	 * 
  	 * @see IVisualResource#getId()
  	 */
  	private String id;
  
  	/**
  	 * Resource tags.
  	 * 
  	 * @see IVisualResource#getTags()
  	 */
  	private List<String> tags;
  
  	/**
  	 * Group id.
  	 * 
  	 * @see IVisualResource#getGroupId()
  	 */
  	private String groupId;
  
  	/**
  	 * Data set or element type.
  	 * 
  	 * @see IVisualResource#getType()
  	 */
  	private Type type;
  
  	private String label;
  
  	private String description;
  
  	private String imagesPath;
  
  	private String imageName;
  
  	private String imageExtension;
  
  	private List<String> imageVariants;
  
  	/**
 	 * Constructor.
 	 * 
 	 * @param id
 	 *            resource id (required)
 	 * @param tags
 	 *            resource tags
 	 * @param groupId
 	 *            resource group id
 	 * @param type
 	 *            associated element or data set type
 	 * @param label
 	 *            resource label (required)
 	 * @param description
 	 *            resource description (required)
 	 * @param imagesPath
 	 *            base path for resource images
 	 * @param imageName
 	 *            name of resource images
 	 * @param imageExtension
 	 *            image extension
 	 * @param imageVariants
 	 *            optional resource variants
 	 */
 	public VisualResourceEntry(String id, List<String> tags, String groupId, Type type, String label,
 	        String description, String imagesPath, String imageName, String imageExtension, List<String> imageVariants) {
 		setId(id);
 		setTags(tags);
 		setGroupId(groupId);
 		setType(type);
 		setLabel(label);
 		setDescription(description);
 		setImagesPath(imagesPath);
 		setImageName(imageName);
 		setImageExtension(imageExtension);
 		setImageVariants(imageVariants);
 	}
 
 	public String getId() {
 		return id;
 	}
 
 	public void setId(String id) {
 		this.id = id;
 	}
 
 	public List<String> getTags() {
 		return tags;
 	}
 
 	public void setTags(List<String> tags) {
 		this.tags = tags;
 	}
 
 	public String getGroupId() {
 		return groupId;
 	}
 
 	public void setGroupId(String groupId) {
 		this.groupId = groupId;
 	}
 
 	public Type getType() {
 		return type;
 	}
 
 	public void setType(Type type) {
 		this.type = type;
 	}
 
 	public String getLabel() {
 		return label;
 	}
 
 	public void setLabel(String label) {
 		this.label = label;
 	}
 
 	public String getDescription() {
 		return description;
 	}
 
 	public void setDescription(String description) {
 		this.description = description;
 	}
 
 	public String getImagesPath() {
 		return imagesPath;
 	}
 
 	public void setImagesPath(String imagesPath) {
 		this.imagesPath = imagesPath;
 	}
 
 	public String getImageName() {
 		return imageName;
 	}
 
 	public void setImageName(String imageName) {
 		this.imageName = imageName;
 	}
 
 	public String getImageExtension() {
 		return imageExtension;
 	}
 
 	public void setImageExtension(String imageExtension) {
 		this.imageExtension = imageExtension;
 	}
 
 	public List<String> getImageVariants() {
 		return imageVariants;
 	}
 
 	public void setImageVariants(List<String> imageVariants) {
 		this.imageVariants = imageVariants;
 	}
 
 }