com.supermap.data
类 JoinItems

java.lang.Object
  com.supermap.data.JoinItems

public class JoinItems
extends java.lang.Object

连接信息集合类。

当一个矢量数据集与多个外部表相连接时，用一个连接信息集合对象来管理其所有的连接信息对象。

构造方法摘要

JoinItems()
构造一个新的 JoinItems 对象。

JoinItems(JoinItem[] joinItems)
根据指定的参数来构造一个 JoinItems 的新对象。

JoinItems(JoinItems joinItems)
根据给定的 JoinItems 对象构造一个与其完全相同的新对象。

方法摘要

int	add(JoinItem joinItem) 将指定的连接信息对象添加到此连接信息集合对象的末尾。
int	addRange(JoinItem[] joinItems) 将指定的多个连接信息对象添加到此连接信息集合对象的末尾。
void	clear() 清除当前连接信息集合对象中的所有元素。
JoinItems	clone() 返回当前 JoinItems 对象的一个拷贝。
void	dispose() 释放该对象所占用的资源。
JoinItem	get(int index) 返回此连接信息集合对象中指定序号的连接信息对象。
int	getCount() 返回此连接信息集合对象中所包含的连接信息对象的总数。
boolean	insert(int index, JoinItem joinItem) 将指定的连接信息对象添加到此连接信息对象集合的指定序号处。
int	insertRange(int index, JoinItem[] joinItems) 将指定的多个连接信息对象添加到此连接信息对象集合中，从指定的序号开始依次添加。
boolean	remove(int index) 将此连接信息集合对象中指定序号处的连接信息对象删除。
int	removeRange(int index, int count) 将此连接信息集合对象中从指定序号开始的指定个数的多个连接信息对象删除。
void	set(int index, JoinItem value) 设置此连接信息集合对象中指定序号的连接信息对象。
JoinItem[]	toArray() 将此连接信息集合对象转换成为一个连接信息对象的数组。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

JoinItems

public JoinItems()

构造一个新的 JoinItems 对象。

JoinItems

public JoinItems(JoinItem[] joinItems)

根据指定的参数来构造一个 JoinItems 的新对象。

参数：

joinItems - 指定的连接信息对象的数组。

JoinItems

public JoinItems(JoinItems joinItems)

根据给定的 JoinItems 对象构造一个与其完全相同的新对象。

参数：

joinItems - 指定的 JoinItems 对象。

方法详细信息

getCount

public int getCount()

返回此连接信息集合对象中所包含的连接信息对象的总数。

返回：

连接信息集合对象中所包含的连接信息对象的总数。

默认值:

默认值为 0。

get

public JoinItem get(int index)

返回此连接信息集合对象中指定序号的连接信息对象。

参数：

index - 指定的序号。

返回：

连接信息集合对象中指定序号的连接信息对象。

set

public void set(int index,
                JoinItem value)

设置此连接信息集合对象中指定序号的连接信息对象。

参数：

index - 指定的序号。

value - 连接信息集合对象中指定序号的连接信息对象。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

clone

public JoinItems clone()

返回当前 JoinItems 对象的一个拷贝。

覆盖：

类 java.lang.Object 中的 clone

返回：

通过克隆操作得到的 JoinItems 对象。

add

public int add(JoinItem joinItem)

将指定的连接信息对象添加到此连接信息集合对象的末尾。

参数：

joinItem - 要添加到此连接信息集合对象中的连接信息对象。

返回：

添加的连接信息对象的序号。

示例:

以下代码示范在连接信息集合中对 JoinItem 对象的一些操作。

 public void addTest(){
        // 假设已经定义了三个 JoinItem 对象，分别为 item1，item2，item3
        // 初始化连接信息集合对象
        JoinItems joinItems = new JoinItems();

        // 将 item1 添加到 items 末尾
        joinItems.add(item1);

        // 将 item2、item3 添加到 items 的末尾
        joinItems.addRange(new JoinItem[] {item2, item3});

        // 将第一个 JoinItem 对象删除
        joinItems.remove(0);

        // 将 item1 添加到第二位置
        joinItems.insert(1, item1);

        // 清除 items 对象
        joinItems.clear();

        // 将 item2、item3、item1 插入到 items 的头部
        joinItems.insertRange(0, new JoinItem[] {item2, item3, item1});

        // 设置 items 的第三项为 item1
        joinItems.set(2, item1);

        // 释放资源
        joinItems.dispose();
    }
 

addRange

public int addRange(JoinItem[] joinItems)

将指定的多个连接信息对象添加到此连接信息集合对象的末尾。

参数：

joinItems - 要添加到此连接信息集合对象中的多个连接信息对象。

返回：

添加的多个连接信息对象的个数。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

insert

public boolean insert(int index,
                      JoinItem joinItem)

将指定的连接信息对象添加到此连接信息对象集合的指定序号处。

参数：

index - 要添加到的序号。

joinItem - 指定要添加的连接信息对象。

返回：

添加成功，返回 true；否则，返回 false。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

insertRange

public int insertRange(int index,
                       JoinItem[] joinItems)

将指定的多个连接信息对象添加到此连接信息对象集合中，从指定的序号开始依次添加。

参数：

index - 添加对象的起始序号。

joinItems - 要添加多个连接信息对象。

返回：

添加的连接信息对象的个数。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

remove

public boolean remove(int index)

将此连接信息集合对象中指定序号处的连接信息对象删除。

参数：

index - 要删除的连接信息对象的序号。

返回：

删除成功，返回 true；否则返回 false。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

removeRange

public int removeRange(int index,
                       int count)

将此连接信息集合对象中从指定序号开始的指定个数的多个连接信息对象删除。

参数：

index - 删除对象的起始序号。

count - 要删除的连接信息对象的个数。

返回：

删除的连接信息对象的个数。

clear

public void clear()

清除当前连接信息集合对象中的所有元素。

另请参见：

add(JoinItem)

示例:

请参见 JoinItems.add() 方法的示例。

toArray

public JoinItem[] toArray()

将此连接信息集合对象转换成为一个连接信息对象的数组。

返回：

此连接信息集合对象转换得到的连接信息对象的数组。

dispose

public void dispose()

释放该对象所占用的资源。当调用该方法之后，此对象不再可用。