feat(print-properties): Adding dorContainer in each component and pageTemplate in FormContainer and new print specific components
#1567
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,18 @@ | |
|
|
||
| import java.io.IOException; | ||
| import java.math.BigDecimal; | ||
| import java.util.AbstractMap; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.Calendar; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.HashSet; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.function.Predicate; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
|
|
@@ -44,11 +55,13 @@ | |
| import com.adobe.aemds.guide.utils.GuideUtils; | ||
| import com.adobe.cq.forms.core.components.datalayer.FormComponentData; | ||
| import com.adobe.cq.forms.core.components.internal.datalayer.ComponentDataImpl; | ||
| import com.adobe.cq.forms.core.components.internal.form.FormConstants; | ||
| import com.adobe.cq.forms.core.components.internal.form.ReservedProperties; | ||
| import com.adobe.cq.forms.core.components.models.form.BaseConstraint; | ||
| import com.adobe.cq.forms.core.components.models.form.FieldType; | ||
| import com.adobe.cq.forms.core.components.models.form.FormComponent; | ||
| import com.adobe.cq.forms.core.components.models.form.Label; | ||
| import com.adobe.cq.forms.core.components.models.form.print.dorapi.DorContainer; | ||
| import com.adobe.cq.wcm.core.components.models.Component; | ||
| import com.adobe.cq.wcm.core.components.util.ComponentUtils; | ||
| import com.day.cq.i18n.I18n; | ||
|
|
@@ -58,6 +71,7 @@ | |
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.fasterxml.jackson.core.JsonGenerator; | ||
| import com.fasterxml.jackson.core.type.TypeReference; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.JsonSerializer; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
@@ -258,6 +272,7 @@ protected boolean getEditMode() { | |
| } | ||
|
|
||
| public static final String CUSTOM_DOR_PROPERTY_WRAPPER = "fd:dor"; | ||
| public static final String CUSTOM_DOR_CONTAINER_WRAPPER = "dorContainer"; | ||
| // used for DOR and SPA editor to work | ||
| public static final String CUSTOM_JCR_PATH_PROPERTY_WRAPPER = "fd:path"; | ||
|
|
||
|
|
@@ -544,6 +559,10 @@ public Map<String, Object> getDorProperties() { | |
| if (dorBindRef != null) { | ||
| customDorProperties.put("dorBindRef", dorBindRef); | ||
| } | ||
| Map<String, Object> dorContainer = getDorContainer(); | ||
| if (dorContainer != null) { | ||
| customDorProperties.put(CUSTOM_DOR_CONTAINER_WRAPPER, dorContainer); | ||
| } | ||
| return customDorProperties; | ||
| } | ||
|
|
||
|
|
@@ -567,4 +586,26 @@ private List<String> getDisabledXFAScripts() { | |
| } | ||
| return new ArrayList<>(disabledScripts); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the dor container properties. | ||
| * | ||
| * @return Map of dor container properties if `fd:dorContainer` node is present otherwise returns null | ||
| */ | ||
| @JsonIgnore | ||
| @Override | ||
| public Map<String, Object> getDorContainer() { | ||
| if (FormConstants.CHANNEL_PRINT.equals(this.channel) && resource != null) { | ||
| Resource dorContainerResource = resource.getChild("fd:dorContainer"); | ||
| if (dorContainerResource != null) { | ||
| DorContainer dorContainer = dorContainerResource.adaptTo(DorContainer.class); | ||
|
There was a problem hiding this comment. this is confusing -> DorContainer for each component, nomenclature needs to be improved, I believe you mean DorComponent and not DorContainer There was a problem hiding this comment. Do we have a single interface for all components? (this seems to be the case, seeing the implementation), how large is it? if its very small, and will not be required to change frequently, then we can have it here, this will lead to removing of dependency of core components on newly introduced print artifact There was a problem hiding this comment.
The name
Yes...we have a single interface for all components because they have a large number of common properties and almost half of them are non-primitive(objects of other classes). Since there were so many classes involved, that's why, @rismehta suggested moving these interfaces to a different artifact. There was a problem hiding this comment. ok, so basically it encapsulates all other classes. Then we might have to live with print dependency. Just make sure that only interfaces are defined in the dependant print artifact. The implementations of these apis are in a different artifact (bundle), this will ensure keeping the dependency light and will be less prone to breaking core components. There was a problem hiding this comment. To keep it lean, we have even segregated the interfaces into two bundles. |
||
| ObjectMapper objectMapper = new ObjectMapper(); | ||
| if (dorContainer != null) { | ||
| return objectMapper.convertValue(dorContainer, new TypeReference<Map<String, Object>>() {}); | ||
| } | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rismehta : Here I am assuming
dorContainernode will be named asfd:dorContainerin JCR, keeping it in consistency withfd:rulesand'fd:events. I hope it is okay.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
take this in spec review meeting