com.exalead.mercury.component.config.descriptor

Class ConnectorField

java.lang.Object

com.exalead.mercury.component.config.descriptor.Item

com.exalead.mercury.component.config.descriptor.Field

com.exalead.mercury.component.config.descriptor.ConnectorField

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ConnectorField
extends Field
implements com.exalead.util.Checkable, java.io.Serializable

An existing CloudView connector

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowDeployed
java.lang.String	allowedConnectorClassId
boolean	allowManaged
boolean	allowUndeployed
boolean	allowUnmanaged
static boolean	DEFAULT_ALLOW_DEPLOYED
static boolean	DEFAULT_ALLOW_MANAGED
static boolean	DEFAULT_ALLOW_UNDEPLOYED
static boolean	DEFAULT_ALLOW_UNMANAGED
static boolean	DEFAULT_INCLUDE_SELF
static boolean	DEFAULT_MULTIPLE_SELECTION
java.lang.String	forbiddenConnectorClassId
boolean	includeSelf
boolean	multipleSelection

Fields inherited from class com.exalead.mercury.component.config.descriptor.Field

allowEmpty, DEFAULT_ALLOW_EMPTY, defaultValue

Fields inherited from class com.exalead.mercury.component.config.descriptor.Item

DEFAULT_IS_HIDDEN, DEFAULT_IS_MANDATORY, description, isHidden, isMandatory, name, ordering, title

Constructor Summary

Constructors

Constructor and Description
ConnectorField()
ConnectorField(ConnectorField o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConnectorField.
static ConnectorField	fromString(java.lang.String s) String representation of this ConnectorField.
java.lang.String	getAllowedConnectorClassId() Regular expression of allowed connectors.
java.lang.String	getForbiddenConnectorClassId() Regular expression of forbidden connectors.
boolean	isAllowDeployed() Are deployed connectors possible values?
boolean	isAllowManaged() Are managed connectors possible values?
boolean	isAllowUndeployed() Are undeployed connectors possible values?
boolean	isAllowUnmanaged() Are unmanaged connectors possible values?
boolean	isIncludeSelf() Is the connector using this field a possible value?
boolean	isMultipleSelection() Can several values be picked?
ConnectorField	makeCopy() Creates and returns a deep copy of this ConnectorField.
static ConnectorField	readFrom(java.io.InputStream is) Read this ConnectorField from an XML fragment.
void	setAllowDeployed(boolean allowDeployed) Are deployed connectors possible values?
void	setAllowedConnectorClassId(java.lang.String allowedConnectorClassId) Regular expression of allowed connectors.
void	setAllowManaged(boolean allowManaged) Are managed connectors possible values?
void	setAllowUndeployed(boolean allowUndeployed) Are undeployed connectors possible values?
void	setAllowUnmanaged(boolean allowUnmanaged) Are unmanaged connectors possible values?
void	setForbiddenConnectorClassId(java.lang.String forbiddenConnectorClassId) Regular expression of forbidden connectors.
void	setIncludeSelf(boolean includeSelf) Is the connector using this field a possible value?
void	setMultipleSelection(boolean multipleSelection) Can several values be picked?
java.lang.String	toString() String representation of this ConnectorField.
ConnectorField	withAllowDeployed(boolean allowDeployed)
ConnectorField	withAllowDeployed(java.lang.Boolean allowDeployed)
ConnectorField	withAllowedConnectorClassId(java.lang.String allowedConnectorClassId)
ConnectorField	withAllowEmpty(boolean allowEmpty)
ConnectorField	withAllowEmpty(java.lang.Boolean allowEmpty)
ConnectorField	withAllowManaged(boolean allowManaged)
ConnectorField	withAllowManaged(java.lang.Boolean allowManaged)
ConnectorField	withAllowUndeployed(boolean allowUndeployed)
ConnectorField	withAllowUndeployed(java.lang.Boolean allowUndeployed)
ConnectorField	withAllowUnmanaged(boolean allowUnmanaged)
ConnectorField	withAllowUnmanaged(java.lang.Boolean allowUnmanaged)
ConnectorField	withDefaultValue(java.lang.String defaultValue)
ConnectorField	withDescription(java.lang.String description)
ConnectorField	withForbiddenConnectorClassId(java.lang.String forbiddenConnectorClassId)
ConnectorField	withIncludeSelf(boolean includeSelf)
ConnectorField	withIncludeSelf(java.lang.Boolean includeSelf)
ConnectorField	withIsHidden(boolean isHidden)
ConnectorField	withIsHidden(java.lang.Boolean isHidden)
ConnectorField	withIsMandatory(boolean isMandatory)
ConnectorField	withIsMandatory(java.lang.Boolean isMandatory)
ConnectorField	withMultipleSelection(boolean multipleSelection)
ConnectorField	withMultipleSelection(java.lang.Boolean multipleSelection)
ConnectorField	withName(java.lang.String name)
ConnectorField	withOrdering(int ordering)
ConnectorField	withOrdering(java.lang.Integer ordering)
ConnectorField	withTitle(java.lang.String title)
void	writeTo(java.io.OutputStream os) Write this ConnectorField as an XML fragment

Methods inherited from class com.exalead.mercury.component.config.descriptor.Field

getDefaultValue, isAllowEmpty, setAllowEmpty, setDefaultValue

Methods inherited from class com.exalead.mercury.component.config.descriptor.Item

getDescription, getName, getOrdering, getTitle, isIsHidden, isIsMandatory, setDescription, setIsHidden, setIsMandatory, setName, setOrdering, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

includeSelf

public boolean includeSelf

DEFAULT_INCLUDE_SELF

public static final boolean DEFAULT_INCLUDE_SELF

See Also:

Constant Field Values

allowDeployed

public boolean allowDeployed

DEFAULT_ALLOW_DEPLOYED

public static final boolean DEFAULT_ALLOW_DEPLOYED

See Also:

Constant Field Values

allowUndeployed

public boolean allowUndeployed

DEFAULT_ALLOW_UNDEPLOYED

public static final boolean DEFAULT_ALLOW_UNDEPLOYED

See Also:

Constant Field Values

allowManaged

public boolean allowManaged

DEFAULT_ALLOW_MANAGED

public static final boolean DEFAULT_ALLOW_MANAGED

See Also:

Constant Field Values

allowUnmanaged

public boolean allowUnmanaged

DEFAULT_ALLOW_UNMANAGED

public static final boolean DEFAULT_ALLOW_UNMANAGED

See Also:

Constant Field Values

allowedConnectorClassId

public java.lang.String allowedConnectorClassId

forbiddenConnectorClassId

public java.lang.String forbiddenConnectorClassId

multipleSelection

public boolean multipleSelection

DEFAULT_MULTIPLE_SELECTION

public static final boolean DEFAULT_MULTIPLE_SELECTION

See Also:

Constant Field Values

Constructor Detail

ConnectorField

public ConnectorField()

ConnectorField

public ConnectorField(ConnectorField o)

Copy constructor

Method Detail

withDefaultValue

public ConnectorField withDefaultValue(java.lang.String defaultValue)

Overrides:

withDefaultValue in class Field

withAllowEmpty

public ConnectorField withAllowEmpty(boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withAllowEmpty

public ConnectorField withAllowEmpty(java.lang.Boolean allowEmpty)

Overrides:

withAllowEmpty in class Field

withName

public ConnectorField withName(java.lang.String name)

Overrides:

withName in class Field

withTitle

public ConnectorField withTitle(java.lang.String title)

Overrides:

withTitle in class Field

withDescription

public ConnectorField withDescription(java.lang.String description)

Overrides:

withDescription in class Field

withIsMandatory

public ConnectorField withIsMandatory(boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsMandatory

public ConnectorField withIsMandatory(java.lang.Boolean isMandatory)

Overrides:

withIsMandatory in class Field

withIsHidden

public ConnectorField withIsHidden(boolean isHidden)

Overrides:

withIsHidden in class Field

withIsHidden

public ConnectorField withIsHidden(java.lang.Boolean isHidden)

Overrides:

withIsHidden in class Field

withOrdering

public ConnectorField withOrdering(int ordering)

Overrides:

withOrdering in class Field

withOrdering

public ConnectorField withOrdering(java.lang.Integer ordering)

Overrides:

withOrdering in class Field

setIncludeSelf

public void setIncludeSelf(boolean includeSelf)

Is the connector using this field a possible value?

isIncludeSelf

public boolean isIncludeSelf()

Is the connector using this field a possible value?

withIncludeSelf

public ConnectorField withIncludeSelf(boolean includeSelf)

withIncludeSelf

public ConnectorField withIncludeSelf(java.lang.Boolean includeSelf)

setAllowDeployed

public void setAllowDeployed(boolean allowDeployed)

Are deployed connectors possible values?

isAllowDeployed

public boolean isAllowDeployed()

Are deployed connectors possible values?

withAllowDeployed

public ConnectorField withAllowDeployed(boolean allowDeployed)

withAllowDeployed

public ConnectorField withAllowDeployed(java.lang.Boolean allowDeployed)

setAllowUndeployed

public void setAllowUndeployed(boolean allowUndeployed)

Are undeployed connectors possible values?

isAllowUndeployed

public boolean isAllowUndeployed()

Are undeployed connectors possible values?

withAllowUndeployed

public ConnectorField withAllowUndeployed(boolean allowUndeployed)

withAllowUndeployed

public ConnectorField withAllowUndeployed(java.lang.Boolean allowUndeployed)

setAllowManaged

public void setAllowManaged(boolean allowManaged)

Are managed connectors possible values?

isAllowManaged

public boolean isAllowManaged()

Are managed connectors possible values?

withAllowManaged

public ConnectorField withAllowManaged(boolean allowManaged)

withAllowManaged

public ConnectorField withAllowManaged(java.lang.Boolean allowManaged)

setAllowUnmanaged

public void setAllowUnmanaged(boolean allowUnmanaged)

Are unmanaged connectors possible values?

isAllowUnmanaged

public boolean isAllowUnmanaged()

Are unmanaged connectors possible values?

withAllowUnmanaged

public ConnectorField withAllowUnmanaged(boolean allowUnmanaged)

withAllowUnmanaged

public ConnectorField withAllowUnmanaged(java.lang.Boolean allowUnmanaged)

setAllowedConnectorClassId

public void setAllowedConnectorClassId(java.lang.String allowedConnectorClassId)

Regular expression of allowed connectors. Empty means all of them

getAllowedConnectorClassId

public java.lang.String getAllowedConnectorClassId()

Regular expression of allowed connectors. Empty means all of them

withAllowedConnectorClassId

public ConnectorField withAllowedConnectorClassId(java.lang.String allowedConnectorClassId)

setForbiddenConnectorClassId

public void setForbiddenConnectorClassId(java.lang.String forbiddenConnectorClassId)

Regular expression of forbidden connectors.

getForbiddenConnectorClassId

public java.lang.String getForbiddenConnectorClassId()

Regular expression of forbidden connectors.

withForbiddenConnectorClassId

public ConnectorField withForbiddenConnectorClassId(java.lang.String forbiddenConnectorClassId)

setMultipleSelection

public void setMultipleSelection(boolean multipleSelection)

Can several values be picked?

isMultipleSelection

public boolean isMultipleSelection()

Can several values be picked?

withMultipleSelection

public ConnectorField withMultipleSelection(boolean multipleSelection)

withMultipleSelection

public ConnectorField withMultipleSelection(java.lang.Boolean multipleSelection)

makeCopy

public ConnectorField makeCopy()

Creates and returns a deep copy of this ConnectorField.

Overrides:

makeCopy in class Field

readFrom

public static ConnectorField readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException

Read this ConnectorField from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ConnectorField as an XML fragment

Overrides:

writeTo in class Field

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ConnectorField fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException

String representation of this ConnectorField.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConnectorField.

Overrides:

toString in class Field

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ConnectorField.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Field

Throws:

com.exalead.util.TypedException