oracle.javatools.db.property

Class PropertyDefinition

java.lang.Object

oracle.javatools.db.property.PropertyInfo

oracle.javatools.db.property.PropertyDefinition

All Implemented Interfaces:

java.lang.Comparable

public final class PropertyDefinition
extends PropertyInfo

Implementation of PropertyInfo that allows each specific property trait to be set. Used to register additional properties with the Metadata by extensions.

Since:

11

See Also:

Metadata.registerProperty(PropertyInfo)

Field Summary

Fields inherited from class oracle.javatools.db.property.PropertyInfo

ID, NAME

Constructor Summary

Constructors

Constructor and Description
PropertyDefinition(java.lang.String name, java.lang.Class returnType, java.lang.Class<? extends DBObjectProvider> providerType, java.lang.Class<? extends DBObject>... objTypes) Creates a new PropertyDescriptor with the given base information.

Method Summary

Methods

Modifier and Type	Method and Description
PropertyDefinition	clone() Creates a new clone of this PropertyDefinition.
protected boolean	equalsImpl(PropertyDefinition other)
protected boolean	equalsImpl(PropertyInfo other)
Nullable.NullBehaviour	getNullBehaviour() Gets the NullBehaviour for this property - i.e.
protected java.util.Collection<java.lang.Class<? extends DBObject>>	getObjectClasses() If this property is restricted to certain object classes this returns those classes.
java.lang.Class	getPropertyClass() Returns the class expected for values of this property.
java.lang.String	getPropertyName() Returns the name of the property.
protected java.lang.Class<? extends DBObjectProvider>	getProviderClass() If this property is restricted to a given provider class this returns that class.
java.lang.Class	getReferencedClass() If this property is a reference property (i.e.
java.lang.String[]	getReferencedTypes() If this property is a reference property this returns the object types that can be referenced by the DBObjectID value.
int	hashCode()
boolean	isNumberPhysicalSize() Tests whether this is a number property that is a physical size so can be displayed as bytes, kilobytes, megabytes etc.
boolean	isNumberUnlimited() Tests whether this is a number property that uses zero to signify an UNLIMITED value.
boolean	isStaticReference() Only valid for properties with a return type of DBObjectID.
boolean	isTextInternalName() Tests whether this property is a text property that represents an internal name, and therefore should be externalised before it is used.
boolean	isTextMultiLine() Tests whether this property is a multi line property - e.g.
boolean	isTextPassword() Tests whether this property is a password and should therefore be treated with appropriate security.
void	setNullBehaviour(Nullable.NullBehaviour nullBehaviour) Sets the NullBehaviour for this property - i.e.
void	setNumberPropertyInfo(boolean unlimited, boolean physicalSize) Sets the information that customises the metadata for a number property.
void	setReferencesInfo(boolean isStatic, java.lang.Class referencedClass, java.lang.String... referencedTypes) Sets the information that customises the metadata for a referenced property (i.e.
void	setTextPropertyInfo(boolean multiLine, boolean password, boolean internalName) Sets the information that customises the metadata for a text property.
java.lang.String	toString()

Methods inherited from class oracle.javatools.db.property.PropertyInfo

compareTo, equals, getAllowedReferenceTypes, getAllowedValues, getAnnotation, getCascadeAction, getDerivedSourceProperty, getDynamicPropertyProvider, getPropertyPath, getPropertyValue, isAfter, isDeprecated, isDerived, isGetTransient, isInternalReference, isSetTransient, isSupported, isTransient, setPropertyValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                  java.lang.Class returnType,
                  java.lang.Class<? extends DBObjectProvider> providerType,
                  java.lang.Class<? extends DBObject>... objTypes)

Creates a new PropertyDescriptor with the given base information.

Parameters:

name - the property name (must not be null, or empty).

returnType - the return type (property class) for the property, (must not be null).

providerType - the type of provider the property is restricted to (can be null).

objTypes - the types of object the property is restricted to (can be null).

Method Detail

getPropertyName

public java.lang.String getPropertyName()

Description copied from class: PropertyInfo

Returns the name of the property.

Specified by:

getPropertyName in class PropertyInfo

getPropertyClass

public java.lang.Class getPropertyClass()

Description copied from class: PropertyInfo

Returns the class expected for values of this property.

Specified by:

getPropertyClass in class PropertyInfo

getObjectClasses

protected java.util.Collection<java.lang.Class<? extends DBObject>> getObjectClasses()

Description copied from class: PropertyInfo

If this property is restricted to certain object classes this returns those classes.

Overrides:

getObjectClasses in class PropertyInfo

Returns:

getProviderClass

protected java.lang.Class<? extends DBObjectProvider> getProviderClass()

Description copied from class: PropertyInfo

If this property is restricted to a given provider class this returns that class.

Overrides:

getProviderClass in class PropertyInfo

equalsImpl

protected boolean equalsImpl(PropertyInfo other)

Specified by:

equalsImpl in class PropertyInfo

equalsImpl

protected boolean equalsImpl(PropertyDefinition other)

clone

public PropertyDefinition clone()

Creates a new clone of this PropertyDefinition.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setReferencesInfo

public void setReferencesInfo(boolean isStatic,
                     java.lang.Class referencedClass,
                     java.lang.String... referencedTypes)

Sets the information that customises the metadata for a referenced property (i.e. whose value is a DBObjectID).

Parameters:

isStatic - whether the value should be exempt from refactoring

referencedClass - the class of object being referenced

referencedTypes - the types of the objects that are referenced.

See Also:

References

isStaticReference

public boolean isStaticReference()

Description copied from class: PropertyInfo

Only valid for properties with a return type of DBObjectID. If true it means that the property is static and shouldn't be replaced by any call to replaceReferenceIDs.

Overrides:

isStaticReference in class PropertyInfo

Returns:

false by default, or true to omit the property value from and replaceReferenceIDs logic on DBObject.

getReferencedClass

public java.lang.Class getReferencedClass()

Description copied from class: PropertyInfo

If this property is a reference property (i.e. property class is DBObjectID) this returns the expected class of object that the property references. By default this is DBObject.class. For non-reference properties this method will return null.

Overrides:

getReferencedClass in class PropertyInfo

Returns:

the expected class of object referenced, or null if this property isn't a reference property.

getReferencedTypes

public java.lang.String[] getReferencedTypes()

Description copied from class: PropertyInfo

If this property is a reference property this returns the object types that can be referenced by the DBObjectID value.

Overrides:

getReferencedTypes in class PropertyInfo

setTextPropertyInfo

public void setTextPropertyInfo(boolean multiLine,
                       boolean password,
                       boolean internalName)

Sets the information that customises the metadata for a text property.

Parameters:

multiLine - whether the value can be multi line

password - whether the value is a password (or other credential) that should never be shown in plain text.

internalName - whether the value is the name of an object in the database (so should be externalised before showing to the user).

See Also:

TextProperty

isTextMultiLine

public boolean isTextMultiLine()

Description copied from class: PropertyInfo

Tests whether this property is a multi line property - e.g. a String property that can contain newlines.

Overrides:

isTextMultiLine in class PropertyInfo

isTextPassword

public boolean isTextPassword()

Description copied from class: PropertyInfo

Tests whether this property is a password and should therefore be treated with appropriate security.

Overrides:

isTextPassword in class PropertyInfo

isTextInternalName

public boolean isTextInternalName()

Description copied from class: PropertyInfo

Tests whether this property is a text property that represents an internal name, and therefore should be externalised before it is used.

Overrides:

isTextInternalName in class PropertyInfo

See Also:

DBObjectProvider.getInternalName(String,String)

setNumberPropertyInfo

public void setNumberPropertyInfo(boolean unlimited,
                         boolean physicalSize)

Sets the information that customises the metadata for a number property.

Parameters:

unlimited - whether the number can be set as "unlimited" rather than a specific number.

physicalSize - whether the number represents a physical size

See Also:

NumberProperty

isNumberUnlimited

public boolean isNumberUnlimited()

Description copied from class: PropertyInfo

Tests whether this is a number property that uses zero to signify an UNLIMITED value. It is expected that all non-zero values will be positive.

Overrides:

isNumberUnlimited in class PropertyInfo

isNumberPhysicalSize

public boolean isNumberPhysicalSize()

Description copied from class: PropertyInfo

Tests whether this is a number property that is a physical size so can be displayed as bytes, kilobytes, megabytes etc.

Overrides:

isNumberPhysicalSize in class PropertyInfo

setNullBehaviour

public void setNullBehaviour(Nullable.NullBehaviour nullBehaviour)

Sets the NullBehaviour for this property - i.e. whether it can be null, and if so what that means.

getNullBehaviour

public Nullable.NullBehaviour getNullBehaviour()

Description copied from class: PropertyInfo

Gets the NullBehaviour for this property - i.e. whether it can be null, and if so what null means as a value.

Overrides:

getNullBehaviour in class PropertyInfo

Returns:

an enum value describing the behaviour of null as a value for this property.