Package adalid.core

Class Key

java.lang.Object

adalid.core.AbstractArtifact

adalid.core.Key

All Implemented Interfaces:

Wrappable, Artifact

public class Key
extends AbstractArtifact

Author:

Jorge Campins

Field Summary

Fields inherited from class adalid.core.AbstractArtifact

ENGLISH, NBSP, PORTUGUESE, SPANISH

Constructor Summary

Constructors

Constructor	Description
Key()

Method Summary

Modifier and Type	Method	Description
List<Property>	dubiousProperties(PersistentEntity entity)
List<String>	dubiousPropertyNames(PersistentEntity entity)
List<KeyField>	getKeyFieldsList()
Property	getTheProperty()
List<Property>	invalidProperties(PersistentEntity entity)
List<String>	invalidPropertyNames(PersistentEntity entity)
boolean	isSingleProperty()
boolean	isUnique()
boolean	isValidKeyFor(PersistentEntity entity)
void	newKeyField(Property property)	El método newKeyField se utiliza para agregar propiedades a la clave.
void	newKeyField(Property... property)	El método newKeyField se utiliza para agregar propiedades a la clave.
void	newKeyField(Property property, SortOption sortOption)	El método newKeyField se utiliza para agregar propiedades a la clave.
void	setUnique(boolean unique)	El método setUnique se utiliza para establecer la unicidad de la clave.

Methods inherited from class adalid.core.AbstractArtifact

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, annotate, checkName, classToString, clearAttributes, coalesce, copyLocalizedStrings, defaultLocale, depth, fa, fieldsToString, finalise, getAlias, getAttribute, getAttribute, getAttributes, getAttributesArray, getAttributesArray, getAttributesKeySetByRegex, getBooleanAttribute, getBooleanAttribute, getClassPath, getDeclaringArtifact, getDeclaringEntity, getDeclaringEntityRoot, getDeclaringField, getDeclaringFieldEntityRoot, getDeclaringFieldIndex, getDeclaringFieldNamedClassSimpleName, getDeclaringFieldPersistentEntityRoot, getDeclaringFieldPersistentEntityTableRoot, getDeclaringOperation, getDeclaringPersistentEntity, getDeclaringPersistentEntityRoot, getDefaultCollectionLabel, getDefaultCollectionShortLabel, getDefaultDescription, getDefaultLabel, getDefaultLocale, getDefaultShortDescription, getDefaultShortLabel, getDefaultSymbol, getDefaultTooltip, getDefaultWrapperClass, getFullName, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getLocalizedCollectionLabel, getLocalizedCollectionShortLabel, getLocalizedDescription, getLocalizedLabel, getLocalizedShortDescription, getLocalizedShortLabel, getLocalizedSymbol, getLocalizedTooltip, getName, getPartialName, getPathList, getPathString, getSqlName, getStringAttribute, getStringAttribute, getStringAttribute, getStringAttribute, getTrace, getValidFieldAnnotations, getValidTypeAnnotations, getValueString, getValueString, getWrapper, hashCodeHexString, isAnnotated, isClassInPath, isDeclared, isExpression, isFinalised, isFontAwesomeClass, isInherited, isInheritedFromAbstract, isInheritedFromConcrete, isLocalizedSymbolDefined, isNotDeclared, isNotInherited, isNotInheritedFromAbstract, isNotInheritedFromConcrete, isOperation, isValidEmbeddedDocument, isValidFieldAnnotation, isValidHelpFileName, isValidHelpFileType, isValidJavaClassName, isValidSnippetFileName, isValidTypeAnnotation, localeReadingKey, localeWritingKey, mapsToString, put, repeat, round, setAlias, setDefaultCollectionLabel, setDefaultCollectionShortLabel, setDefaultDescription, setDefaultLabel, setDefaultShortDescription, setDefaultShortLabel, setDefaultSymbol, setDefaultTooltip, setLocalizedCollectionLabel, setLocalizedCollectionShortLabel, setLocalizedDescription, setLocalizedLabel, setLocalizedShortDescription, setLocalizedShortLabel, setLocalizedSymbol, setLocalizedTooltip, setSqlName, setStaticAttributes, settler, setTrace, specified, specified, specified, specified, specified, specified, toString, toString, toString, toString, toString, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyNames

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key()

Method Detail

getKeyFieldsList

public List<KeyField> getKeyFieldsList()

Returns:

the key fields

isUnique

public boolean isUnique()

Returns:

the unique indicator

setUnique

public void setUnique(boolean unique)

El método setUnique se utiliza para establecer la unicidad de la clave. Las claves únicas no permiten valores duplicados en las propiedades que las integran.

Parameters:

unique - true, si la clave es única; de lo contrario false

newKeyField

public void newKeyField(Property property)

El método newKeyField se utiliza para agregar propiedades a la clave. Las claves pueden estar integradas por una o más propiedades, y para cada propiedad se puede establecer el orden en el índice correspondiente. La posición relativa de cada propiedad en el índice está determinado por la secuencia en la que se agregan a la clave.

Parameters:

property - propiedad de la entidad; el orden en el índice será ascendente.

newKeyField

public void newKeyField(Property property,
                        SortOption sortOption)

El método newKeyField se utiliza para agregar propiedades a la clave. Las claves pueden estar integradas por una o más propiedades, y para cada propiedad se puede establecer el orden en el índice correspondiente. La posición relativa de cada propiedad en el índice está determinado por la secuencia en la que se agregan a la clave.

Parameters:

property - propiedad de la entidad.

sortOption - especifica el orden de la propiedad en el índice. Su valor es uno de los elementos de la enumeración SortOption. Seleccione ASC o DESC para establecer el orden como ascendente o descendente, respectivamente.

newKeyField

public void newKeyField(Property... property)

El método newKeyField se utiliza para agregar propiedades a la clave. Las claves pueden estar integradas por una o más propiedades, y para cada propiedad se puede establecer el orden en el índice correspondiente. La posición relativa de cada propiedad en el índice está determinado por la secuencia en la que se agregan a la clave.

Parameters:

property - una o más propiedades de la entidad; el orden en el índice será ascendente.

isValidKeyFor

public boolean isValidKeyFor(PersistentEntity entity)

invalidPropertyNames

public List<String> invalidPropertyNames(PersistentEntity entity)

invalidProperties

public List<Property> invalidProperties(PersistentEntity entity)

dubiousPropertyNames

public List<String> dubiousPropertyNames(PersistentEntity entity)

dubiousProperties

public List<Property> dubiousProperties(PersistentEntity entity)

isSingleProperty

public boolean isSingleProperty()

getTheProperty

public Property getTheProperty()