001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.objectmanager.data.text;
031
032/**
033 * This class express a width-fixed text format
034 * 
035 * @author Jing Tao
036 */
037public class TextWidthFixedDataFormat implements TextComplexDataFormat {
038        private long lineNumber = -1;// this for a record expand couple physical
039                                                                        // lines
040        private int fieldWidth = 0;// width of filed(in character number)
041        private int fieldStartColumn = -1;// start the field column number
042
043        /**
044         * Constructor with field width
045         * 
046         * @param fieldWidth
047         *            int
048         */
049        public TextWidthFixedDataFormat(int fieldWidth) {
050                this.fieldWidth = fieldWidth;
051        }
052
053        /**
054         * Set line number
055         * 
056         * @param lineNumber
057         *            int
058         */
059        public void setLineNumber(int lineNumber) {
060                this.lineNumber = lineNumber;
061        }
062
063        /**
064         * Get line number
065         * 
066         * @return long
067         */
068        public long getLineNumber() {
069                return lineNumber;
070        }
071
072        /**
073         * Set field width
074         * 
075         * @param fieldWidth
076         *            int
077         */
078        public void setFieldWidth(int fieldWidth) {
079                this.fieldWidth = fieldWidth;
080        }
081
082        /**
083         * Get field width
084         * 
085         * @return int
086         */
087        public int getFieldWidth() {
088                return fieldWidth;
089        }
090
091        /**
092         * Set field start column number
093         * 
094         * @param fieldStartColumn
095         *            long
096         */
097        public void setFieldStartColumn(int fieldStartColumn) {
098                this.fieldStartColumn = fieldStartColumn;
099        }
100
101        /**
102         * Get field start column
103         * 
104         * @return long
105         */
106
107        public int getFieldStartColumn() {
108                return fieldStartColumn;
109        }
110
111}