org.odpi.openmetadata.frameworks.connectors.properties.beans

Class EmbeddedConnection

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.beans.EmbeddedConnection

All Implemented Interfaces:

Serializable

public class EmbeddedConnection
extends PropertyBase

The EmbeddedConnection is used within a VirtualConnection. It contains a connection and additional properties the VirtualConnection uses when working with the EmbeddedConnection.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	arguments
protected String	displayName
protected Connection	embeddedConnection
protected int	position

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
EmbeddedConnection() Default constructor
EmbeddedConnection(EmbeddedConnection template) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
Map<String,Object>	getArguments() Return the arguments for the embedded connection.
String	getDisplayName() Return the printable name of the embedded connection.
Connection	getEmbeddedConnection() Return the embedded connection.
int	getPosition() Return the position that this connector is in the list of embedded connectors.
int	hashCode() Create a hash code for this element type.
void	setArguments(Map<String,Object> arguments) Set up the arguments for the embedded connection.
void	setDisplayName(String displayName) Set up the printable name of the embedded connection.
void	setEmbeddedConnection(Connection embeddedConnection) Set up the embedded connection
void	setPosition(int position) Set up the position that this connector is in the list of embedded connectors.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

position

protected int position

displayName

protected String displayName

arguments

protected Map<String,Object> arguments

embeddedConnection

protected Connection embeddedConnection

Constructor Detail

EmbeddedConnection

public EmbeddedConnection()

Default constructor

EmbeddedConnection

public EmbeddedConnection(EmbeddedConnection template)

Copy/clone constructor.

Parameters:

template - element to copy

Method Detail

getPosition

public int getPosition()

Return the position that this connector is in the list of embedded connectors.

Returns:

int

setPosition

public void setPosition(int position)

Set up the position that this connector is in the list of embedded connectors.

Parameters:

position - int

getDisplayName

public String getDisplayName()

Return the printable name of the embedded connection.

Returns:

String name

setDisplayName

public void setDisplayName(String displayName)

Set up the printable name of the embedded connection.

Parameters:

displayName - String name

getArguments

public Map<String,Object> getArguments()

Return the arguments for the embedded connection.

Returns:

property map

setArguments

public void setArguments(Map<String,Object> arguments)

Set up the arguments for the embedded connection.

Parameters:

arguments - property map

getEmbeddedConnection

public Connection getEmbeddedConnection()

Return the embedded connection.

Returns:

Connection object.

setEmbeddedConnection

public void setEmbeddedConnection(Connection embeddedConnection)

Set up the embedded connection

Parameters:

embeddedConnection - Connection object

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Object

Returns:

int hash code