Package org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.cache

Class PropertyKeywords

java.lang.Object

org.odpi.openmetadata.adapters.repositoryservices.xtdb.repositoryconnector.cache.PropertyKeywords

public class PropertyKeywords
extends Object

Captures the key characteristics of a property mapping.

Constructor Summary

Constructors

Constructor	Description
PropertyKeywords(String namespace, String typeName, String propertyName, TypeDefAttribute attribute)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TypeDefAttribute	getAttribute()	Retrieve the attribute definition for this property.
clojure.lang.Keyword	getEmbeddedKeyword()	Retrieve the keyword to be used for storing embedded JSON-serialized values.
String	getEmbeddedPath()	Retrieve the string representation of the keyword to be used for storing embedded JSON-serialized values.
static String	getEndsWithPropertyNameForMatching(String propertyName)	Retrieve a partially-qualified property name that can be used to compare a Lucene match using ends-with.
String	getPropertyName()	Retrieve the simple name of the property (unqualified), primarily for logging purposes.
clojure.lang.Keyword	getSearchableKeyword()	Retrieve the keyword to be used for storing a searchable value.
String	getSearchablePath()	Retrieve the string representation of the keyword to be used for storing a searchable value.
static String	getSearchableValueKeyword(String namespace, String typeName, String propertyName)	Retrieve the keyword to use to store a searchable value for the property.
static String	getSerializedPropertyKeyword(String namespace, String propertyName)	Retrieve the keyword to use to store the serialized value of the property.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyKeywords

public PropertyKeywords(String namespace,
 String typeName,
 String propertyName,
 TypeDefAttribute attribute)

Method Details

getAttribute

public TypeDefAttribute getAttribute()

Retrieve the attribute definition for this property.

Returns:

TypeDefAttribute

getEmbeddedKeyword

public clojure.lang.Keyword getEmbeddedKeyword()

Retrieve the keyword to be used for storing embedded JSON-serialized values.

Returns:

Keyword

getEmbeddedPath

public String getEmbeddedPath()

Retrieve the string representation of the keyword to be used for storing embedded JSON-serialized values.

Returns:

String

getSearchableKeyword

public clojure.lang.Keyword getSearchableKeyword()

Retrieve the keyword to be used for storing a searchable value.

Returns:

Keyword

getSearchablePath

public String getSearchablePath()

Retrieve the string representation of the keyword to be used for storing a searchable value.

Returns:

String

getPropertyName

public String getPropertyName()

Retrieve the simple name of the property (unqualified), primarily for logging purposes.

Returns:

String

getSerializedPropertyKeyword

public static String getSerializedPropertyKeyword(String namespace,
 String propertyName)

Retrieve the keyword to use to store the serialized value of the property.

Parameters:

namespace - by which to qualify the property

propertyName - of the property

Returns:

String giving the qualified keyword

getSearchableValueKeyword

public static String getSearchableValueKeyword(String namespace,
 String typeName,
 String propertyName)

Retrieve the keyword to use to store a searchable value for the property.

Parameters:

namespace - by which to qualify the property

typeName - by which to qualify the property

propertyName - of the property

Returns:

Keyword giving the qualified keyword for a searchable value

getEndsWithPropertyNameForMatching

public static String getEndsWithPropertyNameForMatching(String propertyName)

Retrieve a partially-qualified property name that can be used to compare a Lucene match using ends-with.

Parameters:

propertyName - of the property to reference

Returns:

String match-able ending to the property (without any type qualification)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object