Field (Ontopia)

java.lang.Object
- net.ontopia.topicmaps.db2tm.Field

```
public class Field
extends Object
```
INTERNAL: Relation mapping concept that refers to a field definition belonging to an entity. There are two categories of fields: identity fields and characteristic fields.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`atype`
`protected String`	`column`
`protected ValueIF`	`cvalue`
`protected String`	`datatype`
`protected Entity`	`entity`
`protected int`	`ftype`
`protected int`	`optional`
`static int`	`OPTIONAL_DEFAULT`
`static int`	`OPTIONAL_FALSE`
`static int`	`OPTIONAL_TRUE`
`protected List<Field>`	`oroles`
`protected String`	`pattern`
`protected String`	`player`
`protected String`	`rtype`
`protected String[]`	`scope`
`protected String`	`type`
`static int`	`TYPE_ASSOCIATION_ROLE`
`static int`	`TYPE_ITEM_IDENTIFIER`
`static int`	`TYPE_OCCURRENCE`
`static int`	`TYPE_PLAYER`
`static int`	`TYPE_SUBJECT_IDENTIFIER`
`static int`	`TYPE_SUBJECT_LOCATOR`
`static int`	`TYPE_TOPIC_NAME`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOtherRoleField(Field orole)`
`void`	`compile()`
`protected void`	`compileValue()`
`String`	`getAssociationType()`
`String`	`getColumn()`
`String`	`getDatatype()`
`Entity`	`getEntity()`
`int`	`getFieldType()`
`int`	`getOptional()`
`List<Field>`	`getOtherRoleFields()`
`String`	`getPattern()`
`String`	`getPlayer()`
`String`	`getRoleType()`
`String[]`	`getScope()`
`String`	`getType()`
`String`	`getValue(String[] tuple)`
`void`	`setAssociationType(String atype)`
`void`	`setColumn(String column)`
`void`	`setDatatype(String datatype)`
`void`	`setOptional(boolean optional)`
`void`	`setPattern(String pattern)`
`void`	`setPlayer(String player)`
`void`	`setRoleType(String rtype)`
`void`	`setScope(String[] scope)`
`void`	`setType(String type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_SUBJECT_LOCATOR
```
public static final int TYPE_SUBJECT_LOCATOR
```
See Also:

Constant Field Values

TYPE_SUBJECT_IDENTIFIER
```
public static final int TYPE_SUBJECT_IDENTIFIER
```
See Also:

Constant Field Values

TYPE_ITEM_IDENTIFIER
```
public static final int TYPE_ITEM_IDENTIFIER
```
See Also:

Constant Field Values

TYPE_TOPIC_NAME
```
public static final int TYPE_TOPIC_NAME
```
See Also:

Constant Field Values

TYPE_OCCURRENCE
```
public static final int TYPE_OCCURRENCE
```
See Also:

Constant Field Values

TYPE_PLAYER
```
public static final int TYPE_PLAYER
```
See Also:

Constant Field Values

TYPE_ASSOCIATION_ROLE
```
public static final int TYPE_ASSOCIATION_ROLE
```
See Also:

Constant Field Values

ftype
```
protected final int ftype
```

entity
```
protected final Entity entity
```

column
```
protected String column
```

pattern
```
protected String pattern
```

type
```
protected String type
```

scope
```
protected String[] scope
```

datatype
```
protected String datatype
```

atype
```
protected String atype
```

rtype
```
protected String rtype
```

player
```
protected String player
```

oroles
```
protected List<Field> oroles
```

OPTIONAL_DEFAULT
```
public static final int OPTIONAL_DEFAULT
```
See Also:

Constant Field Values

OPTIONAL_TRUE
```
public static final int OPTIONAL_TRUE
```
See Also:

Constant Field Values

OPTIONAL_FALSE
```
public static final int OPTIONAL_FALSE
```
See Also:

Constant Field Values

optional
```
protected int optional
```

cvalue
```
protected ValueIF cvalue
```

Method Detail

compile
```
public void compile()
```

getEntity
```
public Entity getEntity()
```

getFieldType
```
public int getFieldType()
```

getColumn
```
public String getColumn()
```

setColumn
```
public void setColumn(String column)
```

getPattern
```
public String getPattern()
```

setPattern

public void setPattern(String pattern)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getDatatype
```
public String getDatatype()
```

setDatatype

public void setDatatype(String datatype)

getScope
```
public String[] getScope()
```

setScope
```
public void setScope(String[] scope)
```

getOptional
```
public int getOptional()
```

setOptional

public void setOptional(boolean optional)

getAssociationType
```
public String getAssociationType()
```

setAssociationType

public void setAssociationType(String atype)

getRoleType
```
public String getRoleType()
```

setRoleType

public void setRoleType(String rtype)

getPlayer
```
public String getPlayer()
```

setPlayer
```
public void setPlayer(String player)
```

addOtherRoleField

public void addOtherRoleField(Field orole)

getOtherRoleFields

public List<Field> getOtherRoleFields()

getValue

public String getValue(String[] tuple)

compileValue
```
protected void compileValue()
```

Class Field

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_SUBJECT_LOCATOR

TYPE_SUBJECT_IDENTIFIER

TYPE_ITEM_IDENTIFIER

TYPE_TOPIC_NAME

TYPE_OCCURRENCE

TYPE_PLAYER

TYPE_ASSOCIATION_ROLE

ftype

entity

column

pattern

type

scope

datatype

atype

rtype

player

oroles

OPTIONAL_DEFAULT

OPTIONAL_TRUE

OPTIONAL_FALSE

optional

cvalue

Method Detail

compile

getEntity

getFieldType

getColumn

setColumn

getPattern

setPattern

getType

setType

getDatatype

setDatatype

getScope

setScope

getOptional

setOptional

getAssociationType

setAssociationType

getRoleType

setRoleType

getPlayer

setPlayer

addOtherRoleField

getOtherRoleFields

getValue

compileValue