rs.sol.soloist.server.guiconfiguration.nonvisualcompoments
Class GUIFindSingleInstanceSAPComponent

java.lang.Object
  rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance
      rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance
          rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance
              rs.sol.soloist.server.builtindomains.common.ObjectOfClass
                  rs.sol.soloist.server.guiconfiguration.construction.GUIComponent
                      rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent
                          rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIServiceAccessPointComponent
                              rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIClassInstancesSAPComponent
                                  rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIFindSingleInstanceSAPComponent

All Implemented Interfaces:

IElementPresentationProvider, IUpdatable, rs.sol.soloist.server.uml.concepts.IElement, IClassifierInstance, IClassInstance, IRTElement

public class GUIFindSingleInstanceSAPComponent
extends GUIClassInstancesSAPComponent

An invisible widget that fetches an object (of a class set by GUIClassInstancesSAPComponent.setClassFQName(String) method) which has a value on its slot (defined by setPropertyName(String) method) equal to the value specified in this widget (by setEqualToValue(IClassifierInstance)). The fetched object is provided on value output pin (GUIServiceAccessPointComponent.opValue() method).

Author:

SOL Expert Group

See Also:

create(GUIContainerComponent, String, String, ClassifierInstanceDescriptor), GUIClassInstancesSAPComponent, GUIServiceAccessPointComponent

Nested Class Summary

static class	GUIFindSingleInstanceSAPComponent.FQPropertyNames Deprecated. Not for public use.
static class	GUIFindSingleInstanceSAPComponent.PROPERTIES Deprecated. Not for public use.

Field Summary

static IClass	CLASSIFIER UML class reference
IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor>	equalToValue Deprecated. Not for public use.
static java.lang.String	FQ_TYPE_NAME Fully qualified UML class name
IAttributeValue<Boolean>	mustExist Deprecated. Not for public use.
IAttributeValue<Text>	propertyName Deprecated. Not for public use.

Fields inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIClassInstancesSAPComponent

classFQName

Fields inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIServiceAccessPointComponent

accessOnInit, element, refresh, value

Fields inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyle, context, description, enabled, init, inputBindings, layoutData, logger, name, outputBindings, ownerTable, parent, removeStyle, show, showInParent, styleName, tooltip, visible

Constructor Summary

GUIFindSingleInstanceSAPComponent()

Method Summary

void	constructor() The domain-specific constructor of the Classifier.
static GUIFindSingleInstanceSAPComponent	create(GUIContainerComponent parent, java.lang.String classFQName, java.lang.String propertyName, rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor equalToValue) Returns new GUIFindSingleInstanceSAPComponent able to fetch a class instance of the given class and with a value of the given property equal to the given value.
static GUIFindSingleInstanceSAPComponent	create(GUIContainerComponent parent, java.lang.String classFQName, java.lang.String propertyName, rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor equalToValue, boolean mustExist) Deprecated. Not for public use.
IClassifierInstance	getEqualToValue() Returns the value based on whose presence on the slot of the given property the instance is searched for.
boolean	getMustExist() Returns whether searched for instance must exist or not.
java.lang.String	getPropertyName() Returns the property FQ name based on which the instance is searched for.
java.util.List<rs.sol.soloist.server.uml.concepts.IElement>	getValues(rs.sol.soloist.server.uml.concepts.IElement el) Returns the collection of elements in some way related to the given element.
void	setEqualToValue(IClassifierInstance equalTo) Sets the value based on whose presence on the slot of the given property the instance is searched for.
void	setMustExist(boolean must) Sets whether searched for instance must exist in the object space or not.
void	setPropertyName(java.lang.String fqName) Sets the property FQ name based on which the instance is searched for.

Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIClassInstancesSAPComponent

getClassFQName, setClassFQName

Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUIServiceAccessPointComponent

getAccessOnInit, handle, ipElement, ipRefresh, opValue, setAccessOnInit

Methods inherited from class rs.sol.soloist.server.guiconfiguration.nonvisualcompoments.GUINonVisualComponent

setCellAlignment, setCellSize, setCellStyle, setCenter, setDirectionAndSize, setLeftRightWidth, setRowColumn, setRowColumn, setSize, setTopBottomHeight, setXY

Methods inherited from class rs.sol.soloist.server.guiconfiguration.construction.GUIComponent

addStyleNames, addValueToSlot, clearSlot, clone, createInfo, createInfoAlreadyValidated, destructor, fillElementInfo, getApplication, getCommands, getCommands, getCommonOwner, getContext, getDescription, getDescrString, getDragIcon, getEnabled, getFeature, getFeature, getInputBindings, getInputPin, getInputPins, getLabelString, getLargeIcon, getLayoutData, getName, getNameString, getOutputPin, getOutputPins, getOwner, getParts, getSetting, getSmallIcon, getStyle, getSubnodes, getTooltip, getTooltipString, getTypeString, getVisible, ipAddStyle, ipEnabled, ipInit, ipRemoveStyle, ipShow, ipShowInParent, ipVisible, isInputPin, isOutputPin, putFeatureInfo, readElement, readElements, readSlot, readSlotAsInfo, readSubnodes, removeValueFromSlot, setContext, setDescription, setEnabled, setLayoutData, setName, setSlot, setSlot, setStyle, setTooltip, setVisible, toTranslateDescriptors, translatePinName, updateInfo, validate, validateParts, validateParts

Methods inherited from class rs.sol.soloist.server.javaimpl.runtime.SOLoistClassInstance

destroy, equals, getAssociationEndInstance, getAssociationEndInstances, getAttributeValue, getAttributeValues, getMyClass, getMyID, getSlot, getSlot, getSlots, getUMLClass, hashCode, isMarkedAsDeleted, toString

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassInstance

accept, accept, exists, getAssociationEndInstance, getAssociationEndInstance, getAssociationEndInstance, getClassifier, hasIdentity, isClassInstance, isDataTypeInstance, isEqualTo, makeClone, markAsDeleted

Methods inherited from class rs.sol.soloist.server.uml.commonimplementation.runtime._ClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getMElement, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf, isKindOf, isModelElement, isRTElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IClassifierInstance

conformsTo, copySlots, copySlots, getAttributeValue, getAttributeValue, getClassifierFQName, getClassifierUQName, getFirstCommonGeneralizer, getFirstCommonGeneralizerFQName, getFirstCommonGeneralizerUQName, getSlot, getSlot, isDirectInstanceOf, isDirectInstanceOf, isInstanceOf, isInstanceOf

Methods inherited from interface rs.sol.soloist.server.uml.concepts.runtime.IRTElement

getMElement

Methods inherited from interface rs.sol.soloist.server.uml.concepts.IElement

isKindOf, isModelElement, isRTElement

Field Detail

mustExist

@Deprecated
public IAttributeValue<Boolean> mustExist

Deprecated. Not for public use.

propertyName

@Deprecated
public IAttributeValue<Text> propertyName

Deprecated. Not for public use.

FQ_TYPE_NAME

public static final java.lang.String FQ_TYPE_NAME

Fully qualified UML class name

See Also:

Constant Field Values

CLASSIFIER

public static final IClass CLASSIFIER

UML class reference

equalToValue

@Deprecated
public IAssociationEndInstance<rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor> equalToValue

Deprecated. Not for public use.

Constructor Detail

GUIFindSingleInstanceSAPComponent

public GUIFindSingleInstanceSAPComponent()

Method Detail

constructor

public void constructor()

Description copied from interface: IClassifierInstance

The domain-specific constructor of the Classifier.

Specified by:

constructor in interface IClassifierInstance

Overrides:

constructor in class GUIClassInstancesSAPComponent

getValues

public java.util.List<rs.sol.soloist.server.uml.concepts.IElement> getValues(rs.sol.soloist.server.uml.concepts.IElement el)

Description copied from class: GUIServiceAccessPointComponent

Returns the collection of elements in some way related to the given element.

Specified by:

getValues in class GUIServiceAccessPointComponent

Parameters:

el - the element for which the related elements should be retrieved

Returns:

the collection of elements related to the given element

create

public static GUIFindSingleInstanceSAPComponent create(GUIContainerComponent parent,
                                                       java.lang.String classFQName,
                                                       java.lang.String propertyName,
                                                       rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor equalToValue)

Returns new GUIFindSingleInstanceSAPComponent able to fetch a class instance of the given class and with a value of the given property equal to the given value.

Returns:

the new GUIFindSingleInstanceSAPComponent

create

@Deprecated
public static GUIFindSingleInstanceSAPComponent create(GUIContainerComponent parent,
                                                                  java.lang.String classFQName,
                                                                  java.lang.String propertyName,
                                                                  rs.sol.soloist.server.builtindomains.common.ClassifierInstanceDescriptor equalToValue,
                                                                  boolean mustExist)

Deprecated. Not for public use.

getMustExist

public boolean getMustExist()

Returns whether searched for instance must exist or not.

Returns:

whether searched for instance must exist or not

See Also:

setMustExist(boolean)

setMustExist

public void setMustExist(boolean must)

Sets whether searched for instance must exist in the object space or not.

Parameters:

must - a boolean that specifies whether searched for instance must exist in the object space or not

getPropertyName

public java.lang.String getPropertyName()

Returns the property FQ name based on which the instance is searched for.

Returns:

the property FQ name based on which the instance is searched for

See Also:

setPropertyName(String)

setPropertyName

public void setPropertyName(java.lang.String fqName)

Sets the property FQ name based on which the instance is searched for.

Parameters:

fqName - the property FQ name

getEqualToValue

public IClassifierInstance getEqualToValue()

Returns the value based on whose presence on the slot of the given property the instance is searched for.

Returns:

the value that should appear on the slot

See Also:

setEqualToValue(IClassifierInstance)

setEqualToValue

public void setEqualToValue(IClassifierInstance equalTo)

Sets the value based on whose presence on the slot of the given property the instance is searched for.

Parameters:

equalTo - the value that should appear on the slot