View Javadoc
1   package org.synchronoss.cpo.core.meta;
2   
3   /*-
4    * [[
5    * core
6    * ==
7    * Copyright (C) 2003 - 2026 Exaxis LLC, Synchronoss Technologies Inc
8    * ==
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   *
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   *
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * ]]
23   */
24  
25  import org.synchronoss.cpo.core.AbstractCpoData;
26  import org.synchronoss.cpo.core.meta.domain.CpoAttribute;
27  
28  /**
29   * Base {@link org.synchronoss.cpo.core.CpoData} implementation for datastore bindings that are
30   * addressed by a positional index (e.g. a JDBC parameter or column index) in addition to the {@link
31   * CpoAttribute} they move data for.
32   *
33   * @author dberry
34   */
35  public abstract class AbstractBindableCpoData extends AbstractCpoData {
36  
37    private int index = -1;
38  
39    /**
40     * Creates an instance bound to the given attribute and positional index.
41     *
42     * @param cpoAttribute the attribute this instance moves data for
43     * @param index the positional index (e.g. parameter or column index) of this binding
44     */
45    public AbstractBindableCpoData(CpoAttribute cpoAttribute, int index) {
46      super(cpoAttribute);
47      this.index = index;
48    }
49  
50    /**
51     * Gets the positional index of this binding.
52     *
53     * @return the positional index (e.g. parameter or column index) of this binding
54     */
55    public int getIndex() {
56      return index;
57    }
58  }