oracle.fmwplatform.envspec.model.topology

Class Installation

java.lang.Object

oracle.fmwplatform.envspec.model.topology.Installation

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<InstallationData>, oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.Substitutable

public class Installation
extends Object
implements oracle.fmwplatform.envspec.common.EntityWithId, oracle.fmwplatform.envspec.common.ContainerAware<InstallationData>, oracle.fmwplatform.envspec.common.Substitutable

A set of installations that comprise the Oracle Home.

Since:

12.2.2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id A logical id that is used to refer to this Installation within the topology
protected String	installer The location and name of the installer image
protected String	installType The install type name for the parts in the installer image

Constructor Summary

Constructors

Constructor and Description
Installation()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object otherObject) An installation is equal if the ids are equal.
String	getId() Returns the id used to reference this model object.
String	getInstaller() Return the installer for this Installation.
String	getInstallType() Return the type of parts that will be installed from this install image.
InstallationData	getParent() Returns the object that contains this entity.
String	getVariableValue(String key) Returns the variable value assigned to the specified key.
int	hashCode()
Installation	setId(String id) Sets the id used to reference this model object.
Installation	setInstaller(String installer) Set the location and name of the installer image.
Installation	setInstallType(String installType) Set the type of parts to install with this install image.
Installation	setParent(InstallationData containerData) Sets the parent of this object.
String	substitute(String text) Replaces substitution keys in the specified text with their corresponding values.
String	toCompactString() Returns a compact string representation of the object in JSON format.
String	toString() Returns a string representation of the object in JSON format.
String	toXmlCompactString() Returns a compact string representation of the object in XML format.
String	toXmlString() Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

A logical id that is used to refer to this Installation within the topology

installer

protected String installer

The location and name of the installer image

installType

protected String installType

The install type name for the parts in the installer image

Constructor Detail

Installation

public Installation()

Method Detail

getParent

public InstallationData getParent()

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Returns the object that contains this entity.

Specified by:

getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<InstallationData>

Returns:

the object that contains this entity

setParent

public Installation setParent(InstallationData containerData)

Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware

Sets the parent of this object. The container object has variables in it that are used by child objects.

Specified by:

setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<InstallationData>

Parameters:

containerData - the parent container

Returns:

the ContainerAware parent object

getId

public String getId()

Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId

Returns the id used to reference this model object.

Specified by:

getId in interface oracle.fmwplatform.envspec.common.EntityWithId

Returns:

the id used to reference this model object

setId

public Installation setId(String id)

Description copied from interface: oracle.fmwplatform.envspec.common.EntityWithId

Sets the id used to reference this model object.

Specified by:

setId in interface oracle.fmwplatform.envspec.common.EntityWithId

Parameters:

id - the id to be used when referencing this model object

Returns:

this (for method chaining)

getInstallType

public String getInstallType()

Return the type of parts that will be installed from this install image.

Returns:

type of install that will be installed from the installer image.

setInstallType

public Installation setInstallType(String installType)

Set the type of parts to install with this install image.

Parameters:

installType - that identifies what parts to install from the install image

Returns:

this Installation object (for method chaining)

getInstaller

public String getInstaller()

Return the installer for this Installation.

Returns:

installer image location and name

setInstaller

public Installation setInstaller(String installer)

Set the location and name of the installer image.

Parameters:

installer - the installer image location and name

Returns:

this Installation object (for method chaining)

toXmlCompactString

public String toXmlCompactString()

Returns a compact string representation of the object in XML format.

Returns:

a compact string representation of the object in XML format

getVariableValue

public String getVariableValue(String key)

Returns the variable value assigned to the specified key.

Specified by:

getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable

Parameters:

key - the key of the variable to be checked

Returns:

the variable value, or null if not found

substitute

public String substitute(String text)

Replaces substitution keys in the specified text with their corresponding values.

Specified by:

substitute in interface oracle.fmwplatform.envspec.common.Substitutable

Parameters:

text - the original text

Returns:

the text with substitution keys replaced

toXmlString

public String toXmlString()

Returns a string representation of the object in XML format.

Returns:

a string representation of the object in XML format

toCompactString

public String toCompactString()

Returns a compact string representation of the object in JSON format.

Returns:

a compact string representation of the object in JSON format

toString

public String toString()

Returns a string representation of the object in JSON format.

Overrides:

toString in class Object

Returns:

a string representation of the object in JSON format

equals

public boolean equals(Object otherObject)

An installation is equal if the ids are equal.

Overrides:

equals in class Object

Parameters:

otherObject - installation to compare

Returns:

true if the id is equal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object