View Javadoc
1   /*
2    * Copyright (c) 2002-2021, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.importexport.business;
35  
36  /**
37   * Describes an SQL column
38   */
39  public class TableColumn
40  {
41      private String _strColumnName;
42      private boolean _bIsPrimaryKey;
43      private ColumnType _columnType;
44  
45      /**
46       * Creates a new table column
47       * 
48       * @param strColumnName
49       *            The name of the column
50       * @param bIsPrimaryKey
51       *            True if the column has a primary key constraint, false otherwise
52       * @param columnType
53       *            The type of the column
54       */
55      public TableColumn( String strColumnName, boolean bIsPrimaryKey, ColumnType columnType )
56      {
57          _strColumnName = strColumnName;
58          _bIsPrimaryKey = bIsPrimaryKey;
59          _columnType = columnType;
60      }
61  
62      /**
63       * Get the name of the column
64       * 
65       * @return The name of the column
66       */
67      public String getColumnName( )
68      {
69          return _strColumnName;
70      }
71  
72      /**
73       * Set the name of the column
74       * 
75       * @param strColumnName
76       *            The name of the column
77       */
78      public void setColumnName( String strColumnName )
79      {
80          this._strColumnName = strColumnName;
81      }
82  
83      /**
84       * Check if this column has a primary key constraint
85       * 
86       * @return True if this column has a primary key constraint, false otherwise
87       */
88      public boolean getIsPrimaryKey( )
89      {
90          return _bIsPrimaryKey;
91      }
92  
93      /**
94       * Set whether this column has a primary key constraint
95       * 
96       * @param bIsPrimaryKey
97       *            True if this column has a primary key constraint, false otherwise
98       */
99      public void setIsPrimaryKey( boolean bIsPrimaryKey )
100     {
101         this._bIsPrimaryKey = bIsPrimaryKey;
102     }
103 
104     /**
105      * Get the type of this column
106      * 
107      * @return The type of this column
108      */
109     public ColumnType getColumnType( )
110     {
111         return _columnType;
112     }
113 
114     /**
115      * Set the type of this column
116      * 
117      * @param columnType
118      *            The type of this column
119      */
120     public void setColumnType( ColumnType columnType )
121     {
122         this._columnType = columnType;
123     }
124 }