#1659 starting generating fielddocs

docs/source/conf.py

@@ -47,6 +47,7 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
+    'javasphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/index.rst

@@ -12,6 +12,7 @@ Metadatamanagement Dokumentation
 
    user_roles
    metadatenabgabe
+   javadoc/packages
 
 
 Indizes und Tabellen

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/AbstractRdcDomainObject.rst

@@ -0,0 +1,68 @@
+.. java:import:: java.time LocalDateTime
+
+.. java:import:: org.springframework.data.annotation CreatedBy
+
+.. java:import:: org.springframework.data.annotation CreatedDate
+
+.. java:import:: org.springframework.data.annotation LastModifiedBy
+
+.. java:import:: org.springframework.data.annotation LastModifiedDate
+
+.. java:import:: org.springframework.data.annotation Version
+
+.. java:import:: lombok Data
+
+AbstractRdcDomainObject
+=======================
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @Data public abstract class AbstractRdcDomainObject
+
+   Base class for all rdc domain objects.
+
+   :author: René Reitmann
+
+Fields
+------
+createdBy
+^^^^^^^^^
+
+.. java:field:: @CreatedBy private String createdBy
+   :outertype: AbstractRdcDomainObject
+
+   The name of the user which has created this object.
+
+createdDate
+^^^^^^^^^^^
+
+.. java:field:: @CreatedDate private LocalDateTime createdDate
+   :outertype: AbstractRdcDomainObject
+
+   The date and time (in UTC) when this domain object was created.
+
+lastModifiedBy
+^^^^^^^^^^^^^^
+
+.. java:field:: @LastModifiedBy private String lastModifiedBy
+   :outertype: AbstractRdcDomainObject
+
+   The name of the user who last saved this object.
+
+lastModifiedDate
+^^^^^^^^^^^^^^^^
+
+.. java:field:: @LastModifiedDate private LocalDateTime lastModifiedDate
+   :outertype: AbstractRdcDomainObject
+
+   The date and time when this object was last saved.
+
+version
+^^^^^^^
+
+.. java:field:: @Version private Long version
+   :outertype: AbstractRdcDomainObject
+
+   Number which is incremented on each save of this object.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Counter.rst

@@ -0,0 +1,42 @@
+.. java:import:: org.springframework.data.annotation Id
+
+.. java:import:: org.springframework.data.mongodb.core.mapping Document
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Builder
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok NoArgsConstructor
+
+Counter
+=======
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @Document @NoArgsConstructor @Data @AllArgsConstructor @Builder public class Counter
+
+   Counter document which can be used to get an incremented sequence number per document id.
+
+   :author: René Reitmann
+
+Fields
+------
+id
+^^
+
+.. java:field:: @Id private String id
+   :outertype: Counter
+
+   The id of the counter, e.g. "orders".
+
+seq
+^^^
+
+.. java:field:: private long seq
+   :outertype: Counter
+
+   The current sequence number.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/I18nString.rst

@@ -0,0 +1,40 @@
+.. java:import:: org.javers.core.metamodel.annotation ValueObject
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Builder
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok NoArgsConstructor
+
+I18nString
+==========
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class I18nString
+
+   Strings that can be represented in English and German.
+
+   :author: René Reitmann, Daniel Katzberg
+
+Fields
+------
+de
+^^
+
+.. java:field:: private String de
+   :outertype: I18nString
+
+   The german version of this string.
+
+en
+^^
+
+.. java:field:: private String en
+   :outertype: I18nString
+
+   The english version of this string.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Period.rst

@@ -0,0 +1,44 @@
+.. java:import:: java.time LocalDate
+
+.. java:import:: org.javers.core.metamodel.annotation ValueObject
+
+.. java:import:: eu.dzhw.fdz.metadatamanagement.common.domain.validation ValidPeriod
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Builder
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok NoArgsConstructor
+
+Period
+======
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @ValidPeriod @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Period
+
+   Objects representing periods in time. All periods must have a start date and an end date and the start must be before or equal to the end date.
+
+   :author: René Reitmann
+
+Fields
+------
+end
+^^^
+
+.. java:field:: private LocalDate end
+   :outertype: Period
+
+   The end date of the period. Mandatory and must not be before start date.
+
+start
+^^^^^
+
+.. java:field:: private LocalDate start
+   :outertype: Period
+
+   The start date of the period. Mandatory and must not be after end date.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Person.rst

@@ -0,0 +1,50 @@
+.. java:import:: javax.validation.constraints NotEmpty
+
+.. java:import:: org.javers.core.metamodel.annotation ValueObject
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Builder
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok NoArgsConstructor
+
+Person
+======
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Person
+
+   A representation of a person.
+
+   :author: Daniel Katzberg
+
+Fields
+------
+firstName
+^^^^^^^^^
+
+.. java:field:: @NotEmpty private String firstName
+   :outertype: Person
+
+   The first name of the person. Must not be empty.
+
+lastName
+^^^^^^^^
+
+.. java:field:: @NotEmpty private String lastName
+   :outertype: Person
+
+   The last name of the person. Must not be empty.
+
+middleName
+^^^^^^^^^^
+
+.. java:field:: private String middleName
+   :outertype: Person
+
+   The middle name of the person.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/Resolution.rst

@@ -0,0 +1,42 @@
+.. java:import:: javax.validation.constraints NotNull
+
+.. java:import:: org.javers.core.metamodel.annotation ValueObject
+
+.. java:import:: lombok AllArgsConstructor
+
+.. java:import:: lombok Builder
+
+.. java:import:: lombok Data
+
+.. java:import:: lombok NoArgsConstructor
+
+Resolution
+==========
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+   :noindex:
+
+.. java:type:: @NoArgsConstructor @Data @AllArgsConstructor @Builder @ValueObject public class Resolution
+
+   Representation of the resolution of images.
+
+   :author: Daniel Katzberg
+
+Fields
+------
+heightY
+^^^^^^^
+
+.. java:field:: @NotNull private Integer heightY
+   :outertype: Resolution
+
+   The height in pixel.
+
+widthX
+^^^^^^
+
+.. java:field:: @NotNull private Integer widthX
+   :outertype: Resolution
+
+   The width in pixel.
+

docs/source/javadoc/eu/dzhw/fdz/metadatamanagement/common/domain/package-index.rst

@@ -0,0 +1,19 @@
+eu.dzhw.fdz.metadatamanagement.common.domain
+============================================
+
+Common domain objects which can be used in all other subdomains of this application.
+
+:author: René Reitmann
+
+.. java:package:: eu.dzhw.fdz.metadatamanagement.common.domain
+
+.. toctree::
+   :maxdepth: 1
+
+   AbstractRdcDomainObject
+   Counter
+   I18nString
+   Period
+   Person
+   Resolution
+