com.univocity.api.entity.DefaultEntityField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of univocity-api Show documentation
uniVocity Data Integration's Public API
There is a newer version: 1.0.6
/*******************************************************************************
 * Copyright (c) 2013 uniVocity Software Pty Ltd. All rights reserved.
 * This file is subject to the terms and conditions defined in file
 * 'LICENSE.txt', which is part of this source code package.
 ******************************************************************************/
package com.univocity.api.entity;

import com.univocity.api.common.*;

/**
 * Provides basic information for a data entity field.
 *
 * @author uniVocity Software Pty Ltd - [email protected]
 *
 */
public class DefaultEntityField {

	private final String name;
	private boolean isIdentifier = false;
	private boolean isNullable = true;
	private boolean isGenerated = false;
	private Object defaultValue = null;
	private int length = -1;

	/**
	 * Creates an entity field instance with its name.
	 * @param name a name that describes a particular field in each record of an entity.
	 */
	public DefaultEntityField(String name) {
		Args.notBlank(name, "Field name");
		this.name = name.trim();
	}

	/**
	 * Obtains the name that describes a particular field in each record of an entity.
	 * @return the field name
	 */
	public String getName() {
		return name;
	}

	/**
	 * Indicates whether values for this field are generated automatically.
	 * @return true if values of this field are generated automatically; false otherwise
	 */
	public boolean isGenerated() {
		return isGenerated;
	}

	/**
	 * Indicates this field is part of the identifier of a record.
	 * @return true if this field is part of the identifier of a record; false otherwise
	 */
	public boolean isIdentifier() {
		return isIdentifier;
	}

	/**
	 * Indicates whether this field can store null values.
	 * @return true if this field accepts null values; false otherwise
	 */
	public boolean isNullable() {
		return this.isNullable;
	}

	/**
	 * Obtains a default value to use when the value of this field is null.
	 * @return the default value of this field.
	 */
	public Object getDefaultValue() {
		return this.defaultValue;
	}

	/**
	 * Defines this field as an identifier (or part of an identifier) of records produced by a data entity.
	 * @param isIdentifier a flag indicating this field is part of the identifiers of a data entity.
	 */
	public void setIdentifier(boolean isIdentifier) {
		this.isIdentifier = isIdentifier;
	}

	/**
	 * Defines whether this field can store null values.
	 * @param isNullable a flag indicating whether this field accepts null values.
	 */
	public void setNullable(boolean isNullable) {
		this.isNullable = isNullable;
	}

	/**
	 * Defines a default value to use when the value of this field is null.
	 * @param defaultValue the default value of this field.
	 */
	public void setDefaultValue(Object defaultValue) {
		this.defaultValue = defaultValue;
	}

	/**
	 * Updates the indication that values for this field are generated automatically.
	 * @param isGenerated a flag indicating values for this field are generated automatically.
	 */
	public void setGenerated(boolean isGenerated) {
		this.isGenerated = isGenerated;
	}

	/**
	 * Obtains the maximum length of this field. A value of -1 means the length is undefined.
	 * defaults to -1
	 *
	 * @return the length of this field.
	 */
	public int getLength() {
		return length;
	}

	/**
	 * Defines the maximum length of this field. A value of -1 means the length is undefined. Zero is not a valid length.
	 * @param length the length of this field.
	 */
	public void setLength(int length) {
		if (length < 0) {
			length = -1;
		} else {
			Args.positive(length, "Field length");
		}
		this.length = length;
	}
}