Package com.polarion.platform.persistence.spi

Class Structure

java.lang.Object

com.polarion.platform.persistence.spi.Structure

All Implemented Interfaces:

IChangeGenerator, IChangeListener, IHasCustomValues, IHasValues, IStructure

public class Structure
extends Object
implements IStructure

This implementation is not thread safe.

Author:

dobisekm

Constructor Summary

Constructors

Constructor	Description
Structure(IPObject pobject, IStructType prototype, boolean readOnly, Map<String,Object> data)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
IContextId	getContextId()
Object	getCustomField(String key)
ICustomField	getCustomFieldPrototype(String key)	Shortcut for ICustomFieldsService.getCustomField(key, getProtoName(), getContextId())
Collection<String>	getCustomFieldsList()
IEnumeration<?>	getEnumeration(String forKey)	Returns the IEnumeration if this one was registered for specific key or null.
IEnumOption	getEnumerationOptionForField(String key, String value)	Returns wrapped enumeration option for given field.
Optional<IEnumType>	getEnumerationTypeForField(String key)
IPObject	getPObject()
IStructType	getPrototype()
Map<String,Object>	getRawData()	This is the low level access method designed for backend implementation.
Object	getValue(String key)	Returns the wrapped value.
int	hashCode()
boolean	isModified()
boolean	isReadOnly()
boolean	isReadOnly(String key)
void	markChanged()
void	setChangeOwner(IChangeListener owner)	Sets the new owner to send the dirty status to.
void	setCustomField(String key, Object value)	Sets the value of the given custom field.
void	setSecurityReferee(ISecurityReferee securityReferee)
void	setValue(String key, Object value)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Structure

public Structure(@NotNull
 IPObject pobject,
 @NotNull
 IStructType prototype,
 boolean readOnly,
 @NotNull
 Map<String,Object> data)

Since:

3.1.2

Method Details

getPObject

public IPObject getPObject()

Since:

3.5

getRawData

public Map<String,Object> getRawData()

This is the low level access method designed for backend implementation. It should not be called by clients.

getPrototype

public IStructType getPrototype()

Specified by:

getPrototype in interface IStructure

getValue

public Object getValue(String key)

Description copied from interface: IStructure

Returns the wrapped value.

Specified by:

getValue in interface IHasValues

Specified by:

getValue in interface IStructure

setValue

public void setValue(String key,
 Object value)

Specified by:

setValue in interface IHasValues

Specified by:

setValue in interface IStructure

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface IStructure

Returns:

true if the whole structure is read-only, false otherwise.

See Also:

• IPObject.isReadOnly()

isReadOnly

public boolean isReadOnly(String key)

Specified by:

isReadOnly in interface IStructure

Returns:

true if the whole structure is read-only or if the given key is defined and is read-only, false otherwise.

See Also:

• IPObject.isReadOnly()

markChanged

public void markChanged()

Specified by:

markChanged in interface IChangeListener

isModified

public boolean isModified()

Specified by:

isModified in interface IStructure

Returns:

True is this object was modified since it's load, false otherwise.

setChangeOwner

public void setChangeOwner(IChangeListener owner)

Description copied from interface: IChangeGenerator

Sets the new owner to send the dirty status to.

Specified by:

setChangeOwner in interface IChangeGenerator

Parameters:

owner - The actual owner or null to remove owner.

getEnumeration

public IEnumeration<?> getEnumeration(String forKey)

Description copied from interface: IStructure

Returns the IEnumeration if this one was registered for specific key or null.

This is a convenience method, which calls the appropriate method on the IDataService

Specified by:

getEnumeration in interface IStructure

Parameters:

forKey - the key of some field of the structure

Returns:

the enumeration factory or null

getEnumerationOptionForField

@Nullable
public IEnumOption getEnumerationOptionForField(@NotNull
 String key,
 @Nullable
 String value)

Description copied from interface: IStructure

Returns wrapped enumeration option for given field.

Specified by:

getEnumerationOptionForField in interface IStructure

Parameters:

key - field name (not null)

value - option id

Returns:

wrapped option (null if and only if optionId is null)

See Also:

• IDataService.getEnumerationForKey(String, String, IContextId)
• IDataService.getEnumerationForEnumId(com.polarion.subterra.base.data.model.IEnumType, IContextId)
• ValueHelper.wrap(IPObject, String, com.polarion.subterra.base.data.model.IType, Object)
• IStructure.getEnumerationTypeForField(String)

getEnumerationTypeForField

@NotNull
public Optional<IEnumType> getEnumerationTypeForField(@NotNull
 String key)

Specified by:

getEnumerationTypeForField in interface IStructure

Returns:

the Optional of IEnumType for the given field if it is of enum or multi-enum type, otherwise returns Optional.empty().

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setSecurityReferee

public void setSecurityReferee(@Nullable
 ISecurityReferee securityReferee)

getContextId

public IContextId getContextId()

Since:

3.6.3

getCustomField

@Nullable
public Object getCustomField(@Nullable
 String key)

Specified by:

getCustomField in interface IHasCustomValues

Parameters:

key - The value of the given custom field or null if no such value exists.

setCustomField

public void setCustomField(@NotNull
 String key,
 @Nullable
 Object value)

Description copied from interface: IHasCustomValues

Sets the value of the given custom field. The value type must be checked against the custom field configuration. If the field configuration does not exist, only the String value is accepted.

Specified by:

setCustomField in interface IHasCustomValues

getCustomFieldsList

@NotNull
public Collection<String> getCustomFieldsList()

Specified by:

getCustomFieldsList in interface IHasCustomValues

Returns:

Collection of String names of custom fields, which are defined for this object or exist on this object.

getCustomFieldPrototype

@NotNull
public ICustomField getCustomFieldPrototype(@NotNull
 String key)

Description copied from interface: IHasCustomValues

Shortcut for ICustomFieldsService.getCustomField(key, getProtoName(), getContextId())

Specified by:

getCustomFieldPrototype in interface IHasCustomValues

See Also:

• ICustomFieldsProvider.getCustomField(String, String, IContextId)