Relation (Ontopia)

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

```
public class Relation
extends Object
```
INTERNAL: Relation mapping concept that represents a relation definition. A relation definition will hold one or more entity defintions.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`columns`
`protected String`	`commit`
`protected String`	`condition`
`protected List<Entity>`	`entities`
`protected RelationMapping`	`mapping`
`protected String`	`name`
`protected String[]`	`pkey`
`static int`	`SYNCHRONIZATION_CHANGELOG`
`static int`	`SYNCHRONIZATION_NONE`
`static int`	`SYNCHRONIZATION_RESCAN`
`static int`	`SYNCHRONIZATION_UNKNOWN`
`protected List<Changelog>`	`syncs`
`protected int`	`synctype`
`protected Map<String,ValueIF>`	`virtualColumns`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntity(Entity entity)`
`void`	`addSync(Changelog sync)`
`void`	`addVirtualColumn(String name, ValueIF vcol)`
`protected void`	`compile()`
`int`	`getColumnIndex(String column)`
`String[]`	`getColumns()`
`String`	`getCommitMode()`
`String`	`getCondition()`
`List<Entity>`	`getEntities()`
`RelationMapping`	`getMapping()` INTERNAL: Returns the relation mapping to which the relation belongs.
`String`	`getName()` INTERNAL: Returns the name of the relation.
`Entity`	`getPrimaryEntity()`
`String[]`	`getPrimaryKey()`
`int`	`getSynchronizationType()`
`static String`	`getSynchronizationTypeName(int synctype)`
`List<Changelog>`	`getSyncs()`
`ValueIF`	`getVirtualColumn(String name)`
`boolean`	`isVirtualColumn(String name)`
`void`	`removeEntity(Entity entity)`
`void`	`removeSync(Changelog sync)`
`void`	`setColumns(String[] columns)`
`void`	`setCommitMode(String commit)`
`void`	`setCondition(String condition)`
`void`	`setName(String name)`
`void`	`setPrimaryKey(String[] pkey)`
`void`	`setSynchronizationType(int synctype)`
`String`	`toString()`

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

Field Detail

name
```
protected String name
```

columns
```
protected String[] columns
```

pkey
```
protected String[] pkey
```

condition
```
protected String condition
```

commit
```
protected String commit
```

mapping

protected final RelationMapping mapping

entities
```
protected List<Entity> entities
```

virtualColumns

protected Map<String,ValueIF> virtualColumns

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

Constant Field Values

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

Constant Field Values

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

Constant Field Values

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

Constant Field Values

synctype
```
protected int synctype
```

syncs
```
protected List<Changelog> syncs
```

Method Detail

getMapping
```
public RelationMapping getMapping()
```
INTERNAL: Returns the relation mapping to which the relation belongs.

getName
```
public String getName()
```
INTERNAL: Returns the name of the relation.

setName
```
public void setName(String name)
```

getPrimaryKey
```
public String[] getPrimaryKey()
```

setPrimaryKey

public void setPrimaryKey(String[] pkey)

getCondition
```
public String getCondition()
```

setCondition

public void setCondition(String condition)

setCommitMode

public void setCommitMode(String commit)

getCommitMode
```
public String getCommitMode()
```

getEntities
```
public List<Entity> getEntities()
```

addEntity
```
public void addEntity(Entity entity)
```

removeEntity

public void removeEntity(Entity entity)

getPrimaryEntity
```
public Entity getPrimaryEntity()
```

getColumns
```
public String[] getColumns()
```

setColumns

public void setColumns(String[] columns)

getColumnIndex

public int getColumnIndex(String column)

isVirtualColumn

public boolean isVirtualColumn(String name)

getVirtualColumn

public ValueIF getVirtualColumn(String name)

addVirtualColumn

public void addVirtualColumn(String name,
                             ValueIF vcol)

getSynchronizationType
```
public int getSynchronizationType()
```

setSynchronizationType

public void setSynchronizationType(int synctype)

getSynchronizationTypeName

public static String getSynchronizationTypeName(int synctype)

getSyncs
```
public List<Changelog> getSyncs()
```

addSync
```
public void addSync(Changelog sync)
```

removeSync

public void removeSync(Changelog sync)

toString
```
public String toString()
```
Overrides:

toString in class Object

compile
```
protected void compile()
```

Class Relation

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

columns

pkey

condition

commit

mapping

entities

virtualColumns

SYNCHRONIZATION_UNKNOWN

SYNCHRONIZATION_NONE

SYNCHRONIZATION_RESCAN

SYNCHRONIZATION_CHANGELOG

synctype

syncs

Method Detail

getMapping

getName

setName

getPrimaryKey

setPrimaryKey

getCondition

setCondition

setCommitMode

getCommitMode

getEntities

addEntity

removeEntity

getPrimaryEntity

getColumns

setColumns

getColumnIndex

isVirtualColumn

getVirtualColumn

addVirtualColumn

getSynchronizationType

setSynchronizationType

getSynchronizationTypeName

getSyncs

addSync

removeSync

toString

compile