java.lang.Object
- org.gcube.informationsystem.types.PropertyTypeName

```
public class PropertyTypeName
extends Object
```
Represents the type name of a property, including its base type and any generic parameters.

Author:

Luca Frosini (ISTI - CNR)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PropertyTypeName.BaseType`	The fundamental data types for properties.
`static class`	`PropertyTypeName.BaseTypeGroup`	Groups of base types.
`static class`	`PropertyTypeName.SemanticType`	String-overlay semantic types: JSON string values (`PropertyTypeName.BaseType.STRING` at the wire level) that carry extra, class-specific validation semantics -- a fixed validation regex and a documented meaning.

Field Summary

Fields
Modifier and Type	Field	Description
`protected static Map<Class<?>,PropertyTypeName.BaseType>`	`BASE_PROPERTY_TYPES_BY_CLASS`	A map of base types, keyed by class.
`protected PropertyTypeName.BaseType`	`baseType`	The base type.
`protected Class<?>`	`clz`	The class of the property.
`static String`	`GENERIC_NOT_ALLOWED_MESSAGE`	Constraint on non-collection base types: only `PropertyTypeName.BaseType.LIST`/`PropertyTypeName.BaseType.SET`/ `PropertyTypeName.BaseType.MAP` may declare a generic type.
`protected PropertyTypeName.BaseType`	`genericBaseType`	The generic base type.
`static String`	`MAP_KEY_MUST_BE_STRING_MESSAGE`	Constraint on `PropertyTypeName.BaseType.MAP`: its key must always be `PropertyTypeName.BaseType.STRING`.
`static String`	`MISSING_GENERIC_TYPE_MESSAGE`	Constraint on `PropertyTypeName.BaseType.LIST`/`PropertyTypeName.BaseType.SET`: the generic type must be declared explicitly (e.g.
`protected String`	`namedTypeName`	The name of the referenced Property-family class, if any -- `null` for flat scalars and for collections of a flat scalar.
`static String`	`NESTED_COLLECTION_NOT_ALLOWED_MESSAGE_FORMAT`	Constraint on `PropertyTypeName.BaseType.LIST`/`PropertyTypeName.BaseType.SET`/`PropertyTypeName.BaseType.MAP`: their generic/value type must be a non-collection base type -- collections cannot be nested.
`protected static Map<Class<?>,PropertyTypeName.SemanticType>`	`SEMANTIC_TYPES_BY_CLASS`	A map of semantic types, keyed by class.
`protected static Map<String,PropertyTypeName.SemanticType>`	`SEMANTIC_TYPES_BY_CLASS_NAME`	A map of semantic types, keyed by class simple name.
`protected boolean`	`structuredType`	Whether this type is structured -- a Property-family class reference or a List/Set/Map, as opposed to a flat scalar (String, Integer, Boolean, Date, ...).

Constructor Summary

Constructors
Constructor	Description
`PropertyTypeName(Class<?> clz)`	Constructs a `PropertyTypeName` from a `Class`.
`PropertyTypeName(Method method)`	Constructs a `PropertyTypeName` from a `Method`'s return type.
`PropertyTypeName(String type)`	Constructs a `PropertyTypeName` from a string representation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`PropertyTypeName.BaseType`	`getBaseType()`	Returns the base type of this property.
`static PropertyTypeName.BaseType`	`getBaseTypeByClass(Class<?> clazz)`	Determines the corresponding `PropertyTypeName.BaseType` for a given class.
`PropertyTypeName.BaseType`	`getGenericBaseType()`	Returns the generic base type of this property, if applicable.
`String`	`getNamedTypeName()`	Returns the simple name of the referenced Property-family class, if any -- direct or as a collection's element type.
`static String`	`getRegexByClass(Class<?> clz)`	Returns a regular expression for validating the string representation of a given class.
`static String`	`getRegexByClassname(String className)`	Returns a regular expression for validating the string representation of a given class name.
`String`	`getType()`	Returns the string representation of this type name.
`int`	`hashCode()`
`boolean`	`isStructuredType()`	Checks whether this property type is structured: a direct Property-family class reference (e.g.
`void`	`setType(String type)`	Sets the type from a string representation.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BASE_PROPERTY_TYPES_BY_CLASS
```
protected static final Map<Class<?>,PropertyTypeName.BaseType> BASE_PROPERTY_TYPES_BY_CLASS
```
    A map of base types, keyed by class.
  - SEMANTIC_TYPES_BY_CLASS
```
protected static final Map<Class<?>,PropertyTypeName.SemanticType> SEMANTIC_TYPES_BY_CLASS
```
    A map of semantic types, keyed by class.
  - SEMANTIC_TYPES_BY_CLASS_NAME
```
protected static final Map<String,PropertyTypeName.SemanticType> SEMANTIC_TYPES_BY_CLASS_NAME
```
    A map of semantic types, keyed by class simple name.
  - baseType
```
protected PropertyTypeName.BaseType baseType
```
    The base type.
  - structuredType
```
protected boolean structuredType
```
    Whether this type is structured -- a Property-family class reference or a List/Set/Map, as opposed to a flat scalar (String, Integer, Boolean, Date, ...). Does not by itself guarantee namedTypeName is set: a scalar-typed collection (e.g. List<Integer>) is structured too, but has no named class to report.
  - genericBaseType
```
protected PropertyTypeName.BaseType genericBaseType
```
    The generic base type.
  - namedTypeName
```
protected String namedTypeName
```
    The name of the referenced Property-family class, if any -- null for flat scalars and for collections of a flat scalar.
  - clz
```
protected Class<?> clz
```
    The class of the property.
  - MISSING_GENERIC_TYPE_MESSAGE
```
public static final String MISSING_GENERIC_TYPE_MESSAGE
```
    Constraint on PropertyTypeName.BaseType.LIST/PropertyTypeName.BaseType.SET: the generic type must be declared explicitly (e.g. Set<Property>, not a bare Set).
    
    See Also:
    
    Constant Field Values
  - GENERIC_NOT_ALLOWED_MESSAGE
```
public static final String GENERIC_NOT_ALLOWED_MESSAGE
```
    Constraint on non-collection base types: only PropertyTypeName.BaseType.LIST/PropertyTypeName.BaseType.SET/ PropertyTypeName.BaseType.MAP may declare a generic type.
    
    See Also:
    
    Constant Field Values
  - MAP_KEY_MUST_BE_STRING_MESSAGE
```
public static final String MAP_KEY_MUST_BE_STRING_MESSAGE
```
    Constraint on PropertyTypeName.BaseType.MAP: its key must always be PropertyTypeName.BaseType.STRING.
    
    See Also:
    
    Constant Field Values
  - NESTED_COLLECTION_NOT_ALLOWED_MESSAGE_FORMAT
```
public static final String NESTED_COLLECTION_NOT_ALLOWED_MESSAGE_FORMAT
```
    Constraint on PropertyTypeName.BaseType.LIST/PropertyTypeName.BaseType.SET/PropertyTypeName.BaseType.MAP: their generic/value type must be a non-collection base type -- collections cannot be nested. A String.format template, taking the offending base type's name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertyTypeName
```
public PropertyTypeName(String type)
```
    Constructs a PropertyTypeName from a string representation.
    
    Parameters:
    
    type - The string representation of the type (e.g., "String", "List<Integer>").
  - PropertyTypeName
```
public PropertyTypeName(Class<?> clz)
```
    Constructs a PropertyTypeName from a Class.
    
    Parameters:
    
    clz - The class of the property.
  - PropertyTypeName
```
public PropertyTypeName(Method method)
```
    Constructs a PropertyTypeName from a Method's return type.
    
    Parameters:
    
    method - The method.
- Method Detail
  - getRegexByClass
```
public static String getRegexByClass(Class<?> clz)
```
    Returns a regular expression for validating the string representation of a given class.
    
    Parameters:
    
    clz - The class.
    
    Returns:
    
    The validation regex, or null if none is defined.
  - getRegexByClassname
```
public static String getRegexByClassname(String className)
```
    Returns a regular expression for validating the string representation of a given class name.
    
    Parameters:
    
    className - The simple name of the class.
    
    Returns:
    
    The validation regex, or null if none is defined.
  - getBaseTypeByClass
```
public static PropertyTypeName.BaseType getBaseTypeByClass(Class<?> clazz)
```
    Determines the corresponding PropertyTypeName.BaseType for a given class.
    
    Parameters:
    
    clazz - The class to check.
    
    Returns:
    
    The corresponding BaseType, or null.
  - setType
```
public void setType(String type)
```
    Sets the type from a string representation.
    
    Parameters:
    
    type - The string representation of the type.
  - getType
```
public String getType()
```
    Returns the string representation of this type name.
    
    Returns:
    
    The type name as a string.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBaseType
```
public PropertyTypeName.BaseType getBaseType()
```
    Returns the base type of this property.
    
    Returns:
    
    The base type.
  - isStructuredType
```
public boolean isStructuredType()
```
    Checks whether this property type is structured: a direct Property-family class reference (e.g. EnumStringProperty), or a List/Set/Map -- as opposed to a flat scalar like String or Integer. A structured collection of scalars (e.g. List<Integer>) is still true here even though it has no named class to report -- check getNamedTypeName() for that.
    
    Returns:
    
    true if this type is a Property-family reference or a collection.
  - getGenericBaseType
```
public PropertyTypeName.BaseType getGenericBaseType()
```
    Returns the generic base type of this property, if applicable.
    
    Returns:
    
    The generic base type, or null.
  - getNamedTypeName
```
public String getNamedTypeName()
```
    Returns the simple name of the referenced Property-family class, if any -- direct or as a collection's element type. null for flat scalars and for collections of a flat scalar, even when isStructuredType() is true.
    
    Returns:
    
    The referenced class name, or null.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class PropertyTypeName

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BASE_PROPERTY_TYPES_BY_CLASS

SEMANTIC_TYPES_BY_CLASS

SEMANTIC_TYPES_BY_CLASS_NAME

baseType

structuredType

genericBaseType

namedTypeName

clz

MISSING_GENERIC_TYPE_MESSAGE

GENERIC_NOT_ALLOWED_MESSAGE

MAP_KEY_MUST_BE_STRING_MESSAGE

NESTED_COLLECTION_NOT_ALLOWED_MESSAGE_FORMAT

Constructor Detail

PropertyTypeName

PropertyTypeName

PropertyTypeName

Method Detail

getRegexByClass

getRegexByClassname

getBaseTypeByClass

setType

getType

toString

getBaseType

isStructuredType

getGenericBaseType

getNamedTypeName

hashCode

equals