Railway.java

/*
 * Copyright 2012 the original author or authors.
 * 
 * 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 com.github.carlomicieli.entities;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.validation.constraints.Size;

import org.hibernate.annotations.Index;
import org.hibernate.validator.constraints.NotBlank;

/**
 * It represents a operator of the rail transport.
 * @author Carlo Micieli
 *
 */
@Entity
@Table(name = "railways")
public class Railway {
	
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private long id;
	
	@NotBlank(message = "railway.name.required")
	@Size(max = 10, message = "railway.name.size.notvalid")
	@Index(name = "idx_railway_name")
	private String name;
	
	@Size(max = 100, message = "railway.fullName.size.notvalid")
	private String fullName;
	
	/**
	 * Create a new railway.
	 */
	public Railway() { //required
	}
	
	/**
	 * Create a new railway.
	 * @param name the railway name.
	 * @param fullName the complete company name.
	 */
	public Railway(String name, String fullName) {
		this.name = name;
		this.fullName = fullName;
	}

	/**
	 * Create a new railway.
	 * @param id the unique railway id.
	 */
	public Railway(long id) {
		this.id = id;
	}

	/**
	 * Returns the unique id for the <em>Railway</em>.
	 * @return the unique id.
	 */
	public long getId() {
		return id;
	}

	/**
	 * Sets the unique id for the <em>Railway</em>.
	 * @param id the unique id.
	 */
	public void setId(long id) {
		this.id = id;
	}

	/**
	 * Returns the railway name.
	 * @return the railway name.
	 */
	public String getName() {
		return name;
	}

	/**
	 * Sets the railway name
	 * @param name the railway name.
	 */
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * Returns the full company name.
	 * @return the full company name.
	 */
	public String getFullName() {
		return fullName;
	}

	/**
	 * Sets the full company name.
	 * @param fullName the full company name.
	 */
	public void setFullName(String fullName) {
		this.fullName = fullName;
	}
	
	/**
	 * Returns a string representation of this <em>Railway</em>.
	 * @return a string representation of the object.
	 */
	@Override
	public String toString() {
		return new StringBuffer()
			.append(getId() + ": ")
			.append(getName())
			.toString();
	}
}