Package org.nuxeo.ecm.core.schema

Class PropertyDescriptor

java.lang.Object

org.nuxeo.ecm.core.schema.PropertyDescriptor

All Implemented Interfaces:

Descriptor

public class PropertyDescriptor
extends Object
implements Descriptor

Descriptor representing a Nuxeo Property.

It maps the xml below:

 <property schema="SCHEMA" name="NAME" secured="true" deprecation="deprecated|removed" fallback="NAME" />
 

Since:

11.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPRECATED
protected String	deprecation
protected String	fallback
protected String	indexOrder
protected String	name
boolean	remove
static final String	REMOVED
Boolean	retainable
protected String	schema
Boolean	secured

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
PropertyDescriptor()

Method Summary

Modifier and Type	Method	Description
boolean	doesRemove()	During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.
String	getDeprecation()
String	getFallback()
String	getId()	The descriptor id, descriptors with same id are merged.
String	getIndexOrder()
String	getName()
String	getSchema()
boolean	isDeprecated()
boolean	isRemoved()
boolean	isRetainable()
boolean	isSecured()
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEPRECATED

public static final String DEPRECATED

See Also:

• Constant Field Values

REMOVED

public static final String REMOVED

See Also:

• Constant Field Values

schema

protected String schema

name

protected String name

secured

public Boolean secured

deprecation

protected String deprecation

fallback

protected String fallback

indexOrder

protected String indexOrder

retainable

public Boolean retainable

remove

public boolean remove

Constructor Details

PropertyDescriptor

public PropertyDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getSchema

public String getSchema()

getName

public String getName()

isSecured

public boolean isSecured()

getDeprecation

public String getDeprecation()

Returns:

deprecated, removed or null

isDeprecated

public boolean isDeprecated()

isRemoved

public boolean isRemoved()

isRetainable

public boolean isRetainable()

Since:

2023

getIndexOrder

public String getIndexOrder()

Since:

11.5

getFallback

public String getFallback()

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

doesRemove

public boolean doesRemove()

Description copied from interface: Descriptor

During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.

If the last descriptor of same id doesRemove() return true, the descriptor for this id will be null.

Specified by:

doesRemove in interface Descriptor

toString

public String toString()

Overrides:

toString in class Object