Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce Type Descriptions Into Classes #34

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

foster33
Copy link
Collaborator

@foster33 foster33 commented Jul 22, 2024

This PR adds Type descriptions into the classes themselves. These descriptions are used when populating the 'Types' field in the Data Dictionary.

If a type does not implement TypePrettyNameSupplier (the new interface that is utilized when populating the 'Types' field), then it will use the default value provided in the interface. This is why some classes do not include these changes.

I am open to feedback based on what the values should be for DATA_DICTIONARY_TYPE_NAME and specifically for DEFAULT_DATA_DICTIONARY_NAME which I assume should not be 'Default'.

Related to dictionary-service/pull/31

This is the same as #33 . That PR was accidentally closed / fork was deleted.
See dictionary-service/pull/23 for more context.

@foster33
Copy link
Collaborator Author

Current values for DATA_DICTIONARY_TYPE_NAME (if not listed, it will use default):

TYPES   ||  APPEARANCE IN DATA DICTIONARY
AbstractGeometryType - Abstract Geometry
BaseType - DEFAULT
DateType - Date
GeoLatType - Latitude
GeoLonType - Longitude
GeometryType - Geometry
GeoType - Geo
HexStringType - Hex String
HitTermType - DEFAULT
IpAddressType - IP Address
IpV4AddressType - IPv4 Address
LcNoDiacriticsListType - Text List
LcNoDiacriticsType - Text
LcType - Lower Case Text
ListType - List
MacAddressType - MAC Address
NoOpType - DEFAULT
NumberListType - Number List
NumberType - Number
PointType - Point
RawDateType - Raw Date
StringType - String
TrimLeadingZerosType - Trimmed Number

apmoriarty
apmoriarty previously approved these changes Nov 18, 2024
Copy link
Collaborator

@apmoriarty apmoriarty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants