Issue 11267

Add short name property to NetworkEntity

11267
Reporter: mdoering
Assignee: jcuadra
Type: Improvement
Summary: Add short name property to NetworkEntity
Priority: Major
Resolution: Fixed
Status: Closed
Created: 2012-05-31 13:49:29.016
Updated: 2013-12-16 17:50:20.12
Resolved: 2013-02-15 17:11:39.408
        
Description: ChecklistBank has a field "short name in the Checklist class which is a super short but unique case insensitive alphanumeric name identifying a datset.
Its used primarily to create very memorable urls as an alternative to the uuids, for example checklist/col for the catalogue of life or checklist/ipni.

Propos to add such a field to the NetworkEntity class to also allow organizations to be addressed with such a shortname.

Its open whether this short name must be unique across all entity types or only within each concrete class. For example I think it makes sense to allow "itis" as a dataset and also as a network. I would only cause trouble if we want to make use of such a shortname in the graph API]]>
    


Author: mdoering@gbif.org
Comment: default would be NULL
Created: 2012-05-31 13:50:01.791
Updated: 2012-05-31 13:50:01.791


Author: mdoering@gbif.org
Comment: needs to be on the individual classes anyway, cause we don't have a shared readonly NetworkEntity, only a WritableNetworkEntity
Created: 2012-05-31 13:57:26.439
Updated: 2012-05-31 13:57:26.439


Author: mdoering@gbif.org
Comment: Calling it alias
Created: 2012-05-31 14:57:37.669
Updated: 2012-05-31 14:57:37.669


Author: mdoering@gbif.org
Comment: API change done. Persistency and factories still needed to be done
Created: 2012-05-31 15:45:57.755
Updated: 2012-05-31 15:45:57.755


Author: fmendez@gbif.org
Created: 2012-06-21 11:26:11.674
Updated: 2012-06-21 11:26:11.674
        
In a review of the 0.1 issues we question whether this will be done for 0.1 or if it can bump to 0.2?
Is it a blocker?
    


Author: mdoering@gbif.org
Comment: no blocker I think. For clb api calls the checklist bank tables are used directly. Can slip to 0.2
Created: 2012-06-21 11:32:00.629
Updated: 2012-06-21 11:32:00.629


Author: jcuadra@gbif.org
Created: 2012-07-09 18:23:11.633
Updated: 2012-07-09 18:24:22.559
        
The status of this issue is marked unresolved, but I see we now have an "alias" attribute on the WritableNetworkEntity class. But persisting/updating this attribute is not supported at the moment - we dont even have an attribute on the DB level.

I can go ahead to implement the support for this all from the DB to the WS, but this issue seems to be like a proposal instead of a concrete decision. Did we arrived on something final here?
    


Author: mdoering@gbif.org
Comment: Yes, please go ahead. THe change was agreed on. It will just be called alias instead of shortname and as you say its part of the api model classes already, but not implemented in the persistence & factory layer (see older comments)
Created: 2012-07-09 18:32:41.602
Updated: 2012-07-09 18:33:03.254


Author: jcuadra@gbif.org
Created: 2012-07-11 12:38:51.652
Updated: 2012-07-11 12:38:51.652
        
Alias now supported everywhere, and ITests in place.

http://code.google.com/p/gbif-registry/source/detail?r=3145
http://code.google.com/p/gbif-registry/source/detail?r=3146
    


Author: lfrancke@gbif.org
Comment: Missing validation in Java that it doesn't exceed 255 characters.
Created: 2012-07-11 17:08:26.42
Updated: 2012-07-11 17:08:26.42


Author: jcuadra@gbif.org
Created: 2013-02-15 17:11:34.843
Updated: 2013-02-15 17:11:56.835
        
I have made a whole new issue, just to be concerned with the suggestion Lars made. This issue originally did not dealt with the validation proposed.

Please see REG-368.