FieldInfo (souwen java api 1.2.01 API)

java.lang.Object
- cn.sowjz.souwen.v1.db.FieldInfo

直接已知子类:

FieldInfo.Binary, FieldInfo.Bit, FieldInfo.Bit2, FieldInfo.Bit4, FieldInfo.Byte, FieldInfo.Byte16, FieldInfo.Category, FieldInfo.Clob, FieldInfo.Int24, FieldInfo.Int32, FieldInfo.Int64, FieldInfo.Sequence, FieldInfo.Short, FieldInfo.Text, FieldInfo.Varchar, FieldInfo.VarcharArray
```
public class FieldInfo
extends Object
```
描述一个全文库字段的类

从以下版本开始:

1.0

版本:

1.1

作者:

Ryan

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`FieldInfo.Binary`
`static class`	`FieldInfo.Bit`
`static class`	`FieldInfo.Bit2`
`static class`	`FieldInfo.Bit4`
`static class`	`FieldInfo.Byte`
`static class`	`FieldInfo.Byte16`
`static class`	`FieldInfo.Category`
`static class`	`FieldInfo.Clob`
`static class`	`FieldInfo.Int24`
`static class`	`FieldInfo.Int32`
`static class`	`FieldInfo.Int64`
`static class`	`FieldInfo.Sequence`
`static class`	`FieldInfo.Short`
`static class`	`FieldInfo.Text`
`static class`	`FieldInfo.Varchar`
`static class`	`FieldInfo.VarcharArray`

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`cached`
`protected byte`	`flag`
`protected String`	`name`
`protected int`	`sn`
`protected boolean`	`store`
`protected boolean`	`time`
`protected int`	`type`
`static int`	`TYPE_BINARY`
`static int`	`TYPE_BIT`
`static int`	`TYPE_BIT2`
`static int`	`TYPE_BIT4`
`static int`	`TYPE_BYTE`
`static int`	`TYPE_BYTE16`
`static int`	`TYPE_CATEGORY`
`static int`	`TYPE_CLOB`
`static int`	`TYPE_INT24`
`static int`	`TYPE_INT32`
`static int`	`TYPE_INT64`
`static int`	`TYPE_SEQUENCE`
`static int`	`TYPE_SHORT`
`static int`	`TYPE_TEXT`
`static int`	`TYPE_VARCHAR`
`static int`	`TYPE_VARCHAR_ARRAY`
`static String[]`	`types`
`protected boolean`	`unsign`

构造器概要

构造器
构造器和说明
`FieldInfo()` 构造
`FieldInfo(byte[] bb)`
`FieldInfo(byte[] bb, int begin)`
`FieldInfo(int sn, String name, int type, boolean cached, boolean unsign, boolean time, boolean store)`
`FieldInfo(int sn, String name, int type, int flag, boolean cached, boolean unsign, boolean time, boolean store)` 构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`byte`	`getFlag()`
`String`	`getName()` 得到字段名
`int`	`getSn()` 返回序号
`int`	`getType()` 得到字段类型
`String`	`getTypeName()`
`boolean`	`isBinaryField()`
`boolean`	`isBitField()`
`boolean`	`isByte16Field()`
`boolean`	`isCached()` 是否压缩
`boolean`	`isCateField()` 是否是分类字段
`boolean`	`isClobField()`
`boolean`	`isInt32Field()` 是否是int32字段
`boolean`	`isInt32TimeField()`
`boolean`	`isInt64Field()` 是否是int64字段
`boolean`	`isIntField()`
`boolean`	`isNativeID()`
`boolean`	`isNumberField()`
`boolean`	`isSequenceField()` 是否是Sequenece字段
`boolean`	`isStore()` 是否存储
`boolean`	`isStringField()`
`boolean`	`isSupportHtml()`
`boolean`	`isTextField()` 是否是文本字段
`boolean`	`isTime()` 是否是时间
`boolean`	`isUnsign()` 是否有符号
`boolean`	`isVarcharField()`
`protected FieldInfo`	`name(String name)`
`void`	`setSn(int sn)`
`protected FieldInfo`	`sn(int sn)` --------------------------------------------------------------
`ByteBuff`	`toByteBuffer(String charset)` 转化成为字节流，便于网络传输。
`String`	`toString()`
`protected FieldInfo`	`type(int type)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

TYPE_TEXT
```
public static final int TYPE_TEXT
```
另请参阅:

常量字段值

TYPE_VARCHAR
```
public static final int TYPE_VARCHAR
```
另请参阅:

常量字段值

TYPE_INT32
```
public static final int TYPE_INT32
```
另请参阅:

常量字段值

TYPE_INT64
```
public static final int TYPE_INT64
```
另请参阅:

常量字段值

TYPE_SEQUENCE
```
public static final int TYPE_SEQUENCE
```
另请参阅:

常量字段值

TYPE_BYTE16
```
public static final int TYPE_BYTE16
```
另请参阅:

常量字段值

TYPE_CLOB
```
public static final int TYPE_CLOB
```
另请参阅:

常量字段值

TYPE_BINARY
```
public static final int TYPE_BINARY
```
另请参阅:

常量字段值

TYPE_BYTE
```
public static final int TYPE_BYTE
```
另请参阅:

常量字段值

TYPE_SHORT
```
public static final int TYPE_SHORT
```
另请参阅:

常量字段值

TYPE_BIT
```
public static final int TYPE_BIT
```
另请参阅:

常量字段值

TYPE_BIT2
```
public static final int TYPE_BIT2
```
另请参阅:

常量字段值

TYPE_BIT4
```
public static final int TYPE_BIT4
```
另请参阅:

常量字段值

TYPE_VARCHAR_ARRAY
```
public static final int TYPE_VARCHAR_ARRAY
```
另请参阅:

常量字段值

TYPE_CATEGORY
```
public static final int TYPE_CATEGORY
```
另请参阅:

常量字段值

TYPE_INT24
```
public static final int TYPE_INT24
```
另请参阅:

常量字段值

types
```
public static final String[] types
```

name
```
protected String name
```

sn
```
protected int sn
```

type
```
protected int type
```

cached
```
protected boolean cached
```

unsign
```
protected boolean unsign
```

time
```
protected boolean time
```

store
```
protected boolean store
```

flag
```
protected byte flag
```

构造器详细资料

FieldInfo
```
public FieldInfo()
```
构造

FieldInfo

public FieldInfo(int sn,
                 String name,
                 int type,
                 int flag,
                 boolean cached,
                 boolean unsign,
                 boolean time,
                 boolean store)

构造

参数:: name - -- 字段名; type - -- 类型; weight - -- 权重; cached - -- 是否被缓存; index - -- 是否分词; compare - -- 是否比较; unsign - -- 是否带符号; time - -- 是否是时间; store - -- 是否存储

FieldInfo

public FieldInfo(int sn,
                 String name,
                 int type,
                 boolean cached,
                 boolean unsign,
                 boolean time,
                 boolean store)

FieldInfo
```
public FieldInfo(byte[] bb)
```

FieldInfo

public FieldInfo(byte[] bb,
                 int begin)

方法详细资料
- isCached
```
public boolean isCached()
```
  是否压缩
  
  返回:
  
  true表示是。false表示不是
- getName
```
public String getName()
```
  得到字段名
  
  返回:
  
  字段名
- getSn
```
public int getSn()
```
  返回序号
  
  返回:
  
  字段序号
- setSn
```
public void setSn(int sn)
```
- isStore
```
public boolean isStore()
```
  是否存储
  
  返回:
  
  true表示是。false表示不是
- isTime
```
public boolean isTime()
```
  是否是时间
  
  返回:
  
  true表示是。false表示不是
- isSequenceField
```
public boolean isSequenceField()
```
  是否是Sequenece字段
  
  返回:
  
  true表示是。false表示不是
- isTextField
```
public boolean isTextField()
```
  是否是文本字段
  
  返回:
  
  true表示是。false表示不是
- isVarcharField
```
public boolean isVarcharField()
```
- isBinaryField
```
public boolean isBinaryField()
```
- isClobField
```
public boolean isClobField()
```
- isByte16Field
```
public boolean isByte16Field()
```
- isNativeID
```
public boolean isNativeID()
```
- isCateField
```
public boolean isCateField()
```
  是否是分类字段
  
  返回:
  
  true表示是。false表示不是
- isInt32Field
```
public boolean isInt32Field()
```
  是否是int32字段
  
  返回:
  
  true表示是。false表示不是
- isInt32TimeField
```
public boolean isInt32TimeField()
```
- isNumberField
```
public boolean isNumberField()
```
- isIntField
```
public boolean isIntField()
```
- isBitField
```
public boolean isBitField()
```
- isInt64Field
```
public boolean isInt64Field()
```
  是否是int64字段
  
  返回:
  
  true表示是。false表示不是
- isStringField
```
public boolean isStringField()
```
- isUnsign
```
public boolean isUnsign()
```
  是否有符号
  
  返回:
  
  true表示是。false表示不是
- getType
```
public int getType()
```
  得到字段类型
  
  返回:
  
  字段类型
- getFlag
```
public byte getFlag()
```
- toString
```
public String toString()
```
  覆盖:
  
  toString 在类中 Object
- toByteBuffer
```
public ByteBuff toByteBuffer(String charset)
                      throws IOException
```
  转化成为字节流，便于网络传输。在进行网络传输的时候，会自动地通过此方法进行传输
  
  参数:
  
  charset - -- 字符集
  
  返回:
  
  字节流对象
  
  抛出:
  
  IOException
- getTypeName
```
public String getTypeName()
```
- isSupportHtml
```
public boolean isSupportHtml()
```
- sn
```
protected FieldInfo sn(int sn)
```
  --------------------------------------------------------------
- name
```
protected FieldInfo name(String name)
```
- type
```
protected FieldInfo type(int type)
```

类 FieldInfo

嵌套类概要

字段概要

构造器概要

方法概要

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

字段详细资料

TYPE_TEXT

TYPE_VARCHAR

TYPE_INT32

TYPE_INT64

TYPE_SEQUENCE

TYPE_BYTE16

TYPE_CLOB

TYPE_BINARY

TYPE_BYTE

TYPE_SHORT

TYPE_BIT

TYPE_BIT2

TYPE_BIT4

TYPE_VARCHAR_ARRAY

TYPE_CATEGORY

TYPE_INT24

types

name

sn

type

cached

unsign

time

store

flag

构造器详细资料

FieldInfo

FieldInfo

FieldInfo

FieldInfo

FieldInfo

方法详细资料

isCached

getName

getSn

setSn

isStore

isTime

isSequenceField

isTextField

isVarcharField

isBinaryField

isClobField

isByte16Field

isNativeID

isCateField

isInt32Field

isInt32TimeField

isNumberField

isIntField

isBitField

isInt64Field

isStringField

isUnsign

getType

getFlag

toString

toByteBuffer

getTypeName

isSupportHtml

sn

name

type