Package org.ivoa.dm.executionbroker

Class StringValueOption

java.lang.Object

org.ivoa.dm.executionbroker.AbstractOption

org.ivoa.dm.executionbroker.StringValueOption

All Implemented Interfaces:

org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="execbroker:StringValueOption",
       role=objectType)
public class StringValueOption
extends AbstractOption
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

A simple string value option. This option enables the client to set a string value pointed to by the path. objectType: StringValueOption

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringValueOption.StringValueOptionBuilder	A builder class for StringValueOption, mainly for use in the functional builder pattern.

Nested classes/interfaces inherited from class org.ivoa.dm.executionbroker.AbstractOption

AbstractOption.AbstractOptionBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	pattern	A regular expression pattern restricting the value.

Fields inherited from class org.ivoa.dm.executionbroker.AbstractOption

_id, kind, path

Constructor Summary

Constructors

Constructor	Description
StringValueOption()	Creates a new StringValueOption
StringValueOption(String pattern, String kind, String path)	full parameter constructor.
StringValueOption(AbstractOption superinstance, String pattern)	Constructor from supertype instance.
StringValueOption(StringValueOption other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
AbstractOption	copyMe()	make a clone of the object taking into account current polymorhic type.
static StringValueOption	createStringValueOption(Consumer<StringValueOption.StringValueOptionBuilder> f)	create a StringValueOption in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
String	getPattern()	Returns pattern Attribute.
void	setPattern(String pPattern)	Set pattern Attribute.
void	updateUsing(StringValueOption other)	Update this object with the content of the given object.
StringValueOption	withPattern(String pPattern)	fluent setter for pattern Attribute.

Methods inherited from class org.ivoa.dm.executionbroker.AbstractOption

createAbstractOption, getId, getKind, getPath, setKind, setPath, updateUsing, withKind, withPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType

getId

Field Details

pattern

@VoDml(id="execbroker:StringValueOption.pattern",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String pattern

A regular expression pattern restricting the value. : Attribute pattern : multiplicity 1

Constructor Details

StringValueOption

public StringValueOption()

Creates a new StringValueOption

StringValueOption

public StringValueOption(String pattern,
 String kind,
 String path)

full parameter constructor.

Parameters:

pattern - A regular expression pattern restricting the value.

kind - The kind of option.

path - The path this option applies to.

StringValueOption

public StringValueOption(StringValueOption other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

StringValueOption

public StringValueOption(AbstractOption superinstance,
 String pattern)

Constructor from supertype instance.

Parameters:

superinstance - The supertype.

pattern - A regular expression pattern restricting the value.

Method Details

copyMe

public AbstractOption copyMe()

make a clone of the object taking into account current polymorhic type.

Overrides:

copyMe in class AbstractOption

Returns:

the cloned object.

updateUsing

public void updateUsing(StringValueOption other)

Update this object with the content of the given object. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

getPattern

public String getPattern()

Returns pattern Attribute.

Returns:

pattern Attribute

setPattern

public void setPattern(String pPattern)

Set pattern Attribute.

Parameters:

pPattern - value to set

withPattern

public StringValueOption withPattern(String pPattern)

fluent setter for pattern Attribute.

Parameters:

pPattern - value to set

Returns:

StringValueOption

createStringValueOption

public static StringValueOption createStringValueOption(Consumer<StringValueOption.StringValueOptionBuilder> f)

create a StringValueOption in functional builder style.

Parameters:

f - the functional builder.

Returns:

an object initialized from the builder.

forceLoad

public void forceLoad()

Specified by:

forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

Overrides:

forceLoad in class AbstractOption

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Overrides:

delete in class AbstractOption