com.mware.core.model.properties.types

Class BcProperty<TRaw>

java.lang.Object

com.mware.core.model.properties.types.BcPropertyBase<TRaw>

com.mware.core.model.properties.types.BcProperty<TRaw>

Direct Known Subclasses:

BooleanBcProperty, ByteArrayBcProperty, ClientApiBcProperty, DateBcProperty, DetectedObjectProperty, DoubleBcProperty, GeoPointBcProperty, GeoShapeBcProperty, IntegerBcProperty, JsonArrayBcProperty, JsonBcProperty, LocalDateBcProperty, LongBcProperty, StreamingBcProperty, StringBcProperty, VideoTranscriptProperty

public abstract class BcProperty<TRaw>
extends BcPropertyBase<TRaw>

Nested Class Summary

Nested classes/interfaces inherited from class com.mware.core.model.properties.types.BcPropertyBase

BcPropertyBase.RawConverter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BcProperty(String propertyName)

Method Summary

Modifier and Type	Method and Description
void	addPropertyValue(ElementMutation<?> mutation, String multiKey, TRaw value, Metadata metadata, Long timestamp, Visibility visibility)
void	addPropertyValue(ElementMutation<?> mutation, String multiKey, TRaw value, Metadata metadata, Visibility visibility)
void	addPropertyValue(ElementMutation<?> mutation, String multiKey, TRaw value, Visibility visibility)
void	addPropertyValue(Element element, String multiKey, TRaw value, Metadata metadata, Visibility visibility, Authorizations authorizations)
void	addPropertyValue(Element element, String multiKey, TRaw value, Visibility visibility, Authorizations authorizations)
void	alterVisibility(ExistingElementMutation<?> elementMutation, String propertyKey, Visibility newVisibility)
Property	getFirstProperty(Element element)
TRaw	getFirstPropertyValue(Element element)
Property	getOnlyProperty(Element element)
TRaw	getOnlyPropertyValue(Element element) Gets the only property value.
TRaw	getOnlyPropertyValueRequired(Element element) Gets the only property value.
Iterable<Property>	getProperties(Element element)
Property	getProperty(Element element, String key)
TRaw	getPropertyValue(Element element, String propertyKey)
TRaw	getPropertyValue(Property property)
Iterable<TRaw>	getPropertyValues(Element element)
boolean	hasProperty(Element element)
boolean	hasProperty(Element element, String propertyKey)
void	hideProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, Property propertyToHide, String workspaceId, Authorizations authorizations)
void	removeProperty(ElementMutation m, String key, Visibility visibility)
void	removeProperty(Element element, String key, Authorizations authorizations)
<T extends Element> void	removeProperty(ElementUpdateContext<T> ctx, String propertyKey, Visibility visibility)
void	removeProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, Visibility visibility)
<T extends Element> void	updateProperty(ElementUpdateContext<T> ctx, String propertyKey, TRaw newValue, Metadata metadata, Long timestamp, Visibility visibility)
<T extends Element> void	updateProperty(ElementUpdateContext<T> ctx, String propertyKey, TRaw newValue, Metadata metadata, Visibility visibility)
<T extends Element> void	updateProperty(ElementUpdateContext<T> ctx, String propertyKey, TRaw newValue, PropertyMetadata metadata)
<T extends Element> void	updateProperty(ElementUpdateContext<T> ctx, String propertyKey, TRaw newValue, PropertyMetadata metadata, Long timestamp)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, Metadata metadata, Long timestamp, Visibility visibility)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, Metadata metadata, Visibility visibility)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, PropertyMetadata metadata)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, PropertyMetadata metadata, Long timestamp)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, PropertyMetadata metadata, Long timestamp, Visibility visibility) Deprecated. Use updateProperty(List, Element, ElementMutation, String, Object, PropertyMetadata, Long)
void	updateProperty(List<BcPropertyUpdate> changedPropertiesOut, Element element, ElementMutation m, String propertyKey, TRaw newValue, PropertyMetadata metadata, Visibility visibility) Deprecated. Use updateProperty(List, Element, ElementMutation, String, Object, PropertyMetadata)

Methods inherited from class com.mware.core.model.properties.types.BcPropertyBase

getPropertyName, getRawConverter, isEquals, isSameName, isSameName, toString, unwrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

BcProperty

protected BcProperty(String propertyName)

Method Detail

addPropertyValue

public final void addPropertyValue(ElementMutation<?> mutation,
                                   String multiKey,
                                   TRaw value,
                                   Visibility visibility)

addPropertyValue

public final void addPropertyValue(Element element,
                                   String multiKey,
                                   TRaw value,
                                   Visibility visibility,
                                   Authorizations authorizations)

addPropertyValue

public final void addPropertyValue(Element element,
                                   String multiKey,
                                   TRaw value,
                                   Metadata metadata,
                                   Visibility visibility,
                                   Authorizations authorizations)

addPropertyValue

public final void addPropertyValue(ElementMutation<?> mutation,
                                   String multiKey,
                                   TRaw value,
                                   Metadata metadata,
                                   Visibility visibility)

addPropertyValue

public final void addPropertyValue(ElementMutation<?> mutation,
                                   String multiKey,
                                   TRaw value,
                                   Metadata metadata,
                                   Long timestamp,
                                   Visibility visibility)

getPropertyValue

public final TRaw getPropertyValue(Element element,
                                   String propertyKey)

getPropertyValue

public final TRaw getPropertyValue(Property property)

Overrides:

getPropertyValue in class BcPropertyBase<TRaw>

getPropertyValues

public final Iterable<TRaw> getPropertyValues(Element element)

hasProperty

public boolean hasProperty(Element element,
                           String propertyKey)

hasProperty

public boolean hasProperty(Element element)

getProperty

public Property getProperty(Element element,
                            String key)

getOnlyProperty

public Property getOnlyProperty(Element element)

getFirstProperty

public Property getFirstProperty(Element element)

getFirstPropertyValue

public TRaw getFirstPropertyValue(Element element)

getProperties

public Iterable<Property> getProperties(Element element)

removeProperty

public void removeProperty(Element element,
                           String key,
                           Authorizations authorizations)

removeProperty

public void removeProperty(ElementMutation m,
                           String key,
                           Visibility visibility)

removeProperty

public <T extends Element> void removeProperty(ElementUpdateContext<T> ctx,
                                               String propertyKey,
                                               Visibility visibility)

alterVisibility

public void alterVisibility(ExistingElementMutation<?> elementMutation,
                            String propertyKey,
                            Visibility newVisibility)

removeProperty

public void removeProperty(List<BcPropertyUpdate> changedPropertiesOut,
                           Element element,
                           ElementMutation m,
                           String propertyKey,
                           Visibility visibility)

hideProperty

public void hideProperty(List<BcPropertyUpdate> changedPropertiesOut,
                         Element element,
                         Property propertyToHide,
                         String workspaceId,
                         Authorizations authorizations)

updateProperty

@Deprecated
public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                                       Element element,
                                       ElementMutation m,
                                       String propertyKey,
                                       TRaw newValue,
                                       PropertyMetadata metadata,
                                       Visibility visibility)

Deprecated. Use updateProperty(List, Element, ElementMutation, String, Object, PropertyMetadata)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                           Element element,
                           ElementMutation m,
                           String propertyKey,
                           TRaw newValue,
                           PropertyMetadata metadata)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public <T extends Element> void updateProperty(ElementUpdateContext<T> ctx,
                                               String propertyKey,
                                               TRaw newValue,
                                               PropertyMetadata metadata)

updateProperty

@Deprecated
public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                                       Element element,
                                       ElementMutation m,
                                       String propertyKey,
                                       TRaw newValue,
                                       PropertyMetadata metadata,
                                       Long timestamp,
                                       Visibility visibility)

Deprecated. Use updateProperty(List, Element, ElementMutation, String, Object, PropertyMetadata, Long)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                           Element element,
                           ElementMutation m,
                           String propertyKey,
                           TRaw newValue,
                           PropertyMetadata metadata,
                           Long timestamp)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public <T extends Element> void updateProperty(ElementUpdateContext<T> ctx,
                                               String propertyKey,
                                               TRaw newValue,
                                               PropertyMetadata metadata,
                                               Long timestamp)

updateProperty

public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                           Element element,
                           ElementMutation m,
                           String propertyKey,
                           TRaw newValue,
                           Metadata metadata,
                           Visibility visibility)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public <T extends Element> void updateProperty(ElementUpdateContext<T> ctx,
                                               String propertyKey,
                                               TRaw newValue,
                                               Metadata metadata,
                                               Visibility visibility)

updateProperty

public void updateProperty(List<BcPropertyUpdate> changedPropertiesOut,
                           Element element,
                           ElementMutation m,
                           String propertyKey,
                           TRaw newValue,
                           Metadata metadata,
                           Long timestamp,
                           Visibility visibility)

Parameters:

changedPropertiesOut - Adds the property to this list if the property value changed

updateProperty

public <T extends Element> void updateProperty(ElementUpdateContext<T> ctx,
                                               String propertyKey,
                                               TRaw newValue,
                                               Metadata metadata,
                                               Long timestamp,
                                               Visibility visibility)

getOnlyPropertyValue

public TRaw getOnlyPropertyValue(Element element)

Gets the only property value. If there are multiple property values with the same name an exception will be thrown. If the property does not exist a null will be returned.

getOnlyPropertyValueRequired

public TRaw getOnlyPropertyValueRequired(Element element)

Gets the only property value. If there are multiple property values with the same name an exception will be thrown. If the property does not exist an exception will be thrown.