JoinMetaData (DataNucleus Core 4.1.17-SNAPSHOT API)

java.lang.Object
- org.datanucleus.metadata.MetaData
- - org.datanucleus.metadata.JoinMetaData

All Implemented Interfaces:

Serializable, ColumnMetaDataContainer
```
public class JoinMetaData
extends MetaData
implements ColumnMetaDataContainer
```
Secondary tables and join tables are mapped using a join condition that associates a column or columns in the secondary or join table with a column or columns in the primary table, typically the primary tables primary key columns. Column elements used for relationship mapping or join conditions specify the column name and optionally the target column name. The target column name is the name of the column in the associated table corresponding to the named column. The target column name is optional when the target column is the single primary key column of the associated table.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`catalog` the catalog name.
`protected String`	`columnName`
`protected List<ColumnMetaData>`	`columns`
`protected ForeignKeyMetaData`	`foreignKeyMetaData` the foreign-key element.
`protected IndexedValue`	`indexed` The indexing value
`protected IndexMetaData`	`indexMetaData` the index element.
`protected boolean`	`outer` if is outer join.
`protected PrimaryKeyMetaData`	`primaryKeyMetaData` PrimaryKey MetaData
`protected String`	`schema` the schema name.
`protected String`	`table` the table name.
`protected boolean`	`unique` Whether to add a unique constraint.
`protected UniqueMetaData`	`uniqueMetaData` the unique element.

Fields inherited from class org.datanucleus.metadata.MetaData
EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_DISABLE, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_CASCADE_UPDATE, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_FETCH_FK_ONLY, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATEABLE, extensions, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors
Constructor and Description

JoinMetaData()

JoinMetaData(JoinMetaData joinmd)
Copy constructor.

Constructors
Constructor and Description
`JoinMetaData()`
`JoinMetaData(JoinMetaData joinmd)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(ColumnMetaData colmd)` Add a new ColumnMetaData element
`String`	`getCatalog()`
`ColumnMetaData[]`	`getColumnMetaData()` Accessor for columnMetaData
`String`	`getColumnName()`
`String`	`getDeleteAction()`
`ForeignKeyMetaData`	`getForeignKeyMetaData()`
`IndexedValue`	`getIndexed()`
`IndexMetaData`	`getIndexMetaData()`
`PrimaryKeyMetaData`	`getPrimaryKeyMetaData()` Accessor for primaryKeyMetaData
`String`	`getSchema()`
`String`	`getTable()`
`UniqueMetaData`	`getUniqueMetaData()`
`void`	`initialise(ClassLoaderResolver clr, MetaDataManager mmgr)` Method to initialise the object, creating internal convenience arrays.
`boolean`	`isOuter()`
`boolean`	`isUnique()`
`ColumnMetaData`	`newColumnMetaData()` Method to create a new column metadata, add it, and return it.
`ForeignKeyMetaData`	`newForeignKeyMetaData()` Method to create a new FK metadata, set to use it, and return it.
`IndexMetaData`	`newIndexMetaData()` Method to create a new index metadata, set to use it, and return it.
`PrimaryKeyMetaData`	`newPrimaryKeyMetaData()` Method to create a new PK metadata, set to use it, and return it.
`UniqueMetaData`	`newUniqueMetaData()` Method to create a new unique metadata, set to use it, and return it.
`JoinMetaData`	`setCatalog(String catalog)`
`JoinMetaData`	`setColumnName(String columnName)`
`JoinMetaData`	`setDeleteAction(String deleteAction)`
`void`	`setForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)`
`JoinMetaData`	`setIndexed(IndexedValue indexed)`
`void`	`setIndexMetaData(IndexMetaData indexMetaData)`
`JoinMetaData`	`setOuter(boolean outer)`
`void`	`setPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)` Mutator for the PrimaryKey MetaData.
`JoinMetaData`	`setSchema(String schema)`
`JoinMetaData`	`setTable(String table)`
`JoinMetaData`	`setUnique(boolean unique)`
`JoinMetaData`	`setUnique(String unique)`
`void`	`setUniqueMetaData(UniqueMetaData uniqueMetaData)`
`String`	`toString(String prefix, String indent)` Returns a string representation of the object using a prefix

Methods inherited from class org.datanucleus.metadata.MetaData
addExtension, addExtension, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString

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

- Field Detail
  - foreignKeyMetaData
```
protected ForeignKeyMetaData foreignKeyMetaData
```
    the foreign-key element.
  - indexMetaData
```
protected IndexMetaData indexMetaData
```
    the index element.
  - uniqueMetaData
```
protected UniqueMetaData uniqueMetaData
```
    the unique element.
  - primaryKeyMetaData
```
protected PrimaryKeyMetaData primaryKeyMetaData
```
    PrimaryKey MetaData
  - outer
```
protected boolean outer
```
    if is outer join. Outer joins return all elements from at least one of the sides joined.
  - table
```
protected String table
```
    the table name.
  - catalog
```
protected String catalog
```
    the catalog name.
  - schema
```
protected String schema
```
    the schema name.
  - indexed
```
protected IndexedValue indexed
```
    The indexing value
  - unique
```
protected boolean unique
```
    Whether to add a unique constraint.
  - columnName
```
protected String columnName
```
  - columns
```
protected List<ColumnMetaData> columns
```
- Constructor Detail
  - JoinMetaData
```
public JoinMetaData()
```
  - JoinMetaData
```
public JoinMetaData(JoinMetaData joinmd)
```
    Copy constructor.
    
    Parameters:
    
    joinmd - Metadata to copy
- Method Detail
  - initialise
```
public void initialise(ClassLoaderResolver clr,
                       MetaDataManager mmgr)
```
    Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects.
    
    Overrides:
    
    initialise in class MetaData
  - addColumn
```
public void addColumn(ColumnMetaData colmd)
```
    Add a new ColumnMetaData element
    
    Specified by:
    
    addColumn in interface ColumnMetaDataContainer
    
    Parameters:
    
    colmd - The ColumnMetaData to add
  - newColumnMetaData
```
public ColumnMetaData newColumnMetaData()
```
    Method to create a new column metadata, add it, and return it.
    
    Returns:
    
    The column metadata
  - isOuter
```
public final boolean isOuter()
```
  - setOuter
```
public JoinMetaData setOuter(boolean outer)
```
  - getDeleteAction
```
public String getDeleteAction()
```
  - setDeleteAction
```
public JoinMetaData setDeleteAction(String deleteAction)
```
  - getIndexed
```
public IndexedValue getIndexed()
```
  - setIndexed
```
public JoinMetaData setIndexed(IndexedValue indexed)
```
  - isUnique
```
public boolean isUnique()
```
  - setUnique
```
public JoinMetaData setUnique(boolean unique)
```
  - setUnique
```
public JoinMetaData setUnique(String unique)
```
  - getTable
```
public final String getTable()
```
  - setTable
```
public JoinMetaData setTable(String table)
```
  - getCatalog
```
public final String getCatalog()
```
  - setCatalog
```
public JoinMetaData setCatalog(String catalog)
```
  - getSchema
```
public final String getSchema()
```
  - setSchema
```
public JoinMetaData setSchema(String schema)
```
  - getColumnName
```
public final String getColumnName()
```
  - setColumnName
```
public JoinMetaData setColumnName(String columnName)
```
  - getColumnMetaData
```
public final ColumnMetaData[] getColumnMetaData()
```
    Accessor for columnMetaData
    
    Specified by:
    
    getColumnMetaData in interface ColumnMetaDataContainer
    
    Returns:
    
    Returns the columnMetaData.
  - getIndexMetaData
```
public final IndexMetaData getIndexMetaData()
```
    Returns:
    
    Returns the indexMetaData.
  - getUniqueMetaData
```
public final UniqueMetaData getUniqueMetaData()
```
    Returns:
    
    Returns the uniquexMetaData.
  - getForeignKeyMetaData
```
public final ForeignKeyMetaData getForeignKeyMetaData()
```
    Returns:
    
    Returns the foreignKeyMetaData.
  - getPrimaryKeyMetaData
```
public final PrimaryKeyMetaData getPrimaryKeyMetaData()
```
    Accessor for primaryKeyMetaData
    
    Returns:
    
    Returns the primaryKey MetaData.
  - setForeignKeyMetaData
```
public final void setForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)
```
    Parameters:
    
    foreignKeyMetaData - The foreignKeyMetaData to set.
  - newForeignKeyMetaData
```
public ForeignKeyMetaData newForeignKeyMetaData()
```
    Method to create a new FK metadata, set to use it, and return it.
    
    Returns:
    
    The FK metadata
  - setIndexMetaData
```
public final void setIndexMetaData(IndexMetaData indexMetaData)
```
    Parameters:
    
    indexMetaData - The indexMetaData to set.
  - newIndexMetaData
```
public IndexMetaData newIndexMetaData()
```
    Method to create a new index metadata, set to use it, and return it.
    
    Returns:
    
    The index metadata
  - setUniqueMetaData
```
public final void setUniqueMetaData(UniqueMetaData uniqueMetaData)
```
    Parameters:
    
    uniqueMetaData - The uniqueMetaData to set.
  - newUniqueMetaData
```
public UniqueMetaData newUniqueMetaData()
```
    Method to create a new unique metadata, set to use it, and return it.
    
    Returns:
    
    The unique metadata
  - setPrimaryKeyMetaData
```
public final void setPrimaryKeyMetaData(PrimaryKeyMetaData primaryKeyMetaData)
```
    Mutator for the PrimaryKey MetaData.
    
    Parameters:
    
    primaryKeyMetaData - The PrimaryKey MetaData to set.
  - newPrimaryKeyMetaData
```
public PrimaryKeyMetaData newPrimaryKeyMetaData()
```
    Method to create a new PK metadata, set to use it, and return it.
    
    Returns:
    
    The PK metadata
  - toString
```
public String toString(String prefix,
                       String indent)
```
    Returns a string representation of the object using a prefix
    
    Overrides:
    
    toString in class MetaData
    
    Parameters:
    
    prefix - prefix string
    
    indent - indent string
    
    Returns:
    
    a string representation of the object.

Class JoinMetaData

Field Summary

Fields inherited from class org.datanucleus.metadata.MetaData

Constructor Summary

Method Summary

Methods inherited from class org.datanucleus.metadata.MetaData

Methods inherited from class java.lang.Object

Field Detail

foreignKeyMetaData

indexMetaData

uniqueMetaData

primaryKeyMetaData

outer

table

catalog

schema

indexed

unique

columnName

columns

Constructor Detail

JoinMetaData

JoinMetaData

Method Detail

initialise

addColumn

newColumnMetaData

isOuter

setOuter

getDeleteAction

setDeleteAction

getIndexed

setIndexed

isUnique

setUnique

setUnique

getTable

setTable

getCatalog

setCatalog

getSchema

setSchema

getColumnName

setColumnName

getColumnMetaData

getIndexMetaData

getUniqueMetaData

getForeignKeyMetaData

getPrimaryKeyMetaData

setForeignKeyMetaData

newForeignKeyMetaData

setIndexMetaData

newIndexMetaData

setUniqueMetaData

newUniqueMetaData

setPrimaryKeyMetaData

newPrimaryKeyMetaData

toString