From 9286aa047f3d49ebcc0ecbe9d389920fc702c7de Mon Sep 17 00:00:00 2001
From: Seiphon <871358932@qq.com>
Date: Wed, 6 Nov 2019 13:19:35 +0800
Subject: [PATCH] DTD hover/completion support for documentation

Fixes #585

Signed-off-by: Seiphon Wang <seiphon.wang@liferay.com>
---
 .../CMDTDAttributeDeclaration.java            |  13 +-
 .../dtd/contentmodel/CMDTDDocument.java       | 103 ++-
 .../contentmodel/CMDTDElementDeclaration.java |  27 +-
 .../DTDCompletionExtensionsTest.java          |   5 +-
 .../contentmodel/DTDHoverExtensionsTest.java  |  64 ++
 .../resources/catalogs/catalog-liferay.xml    |   6 +
 .../dtd/liferay-service-builder_7_2_0.dtd     | 845 ++++++++++++++++++
 7 files changed, 1055 insertions(+), 8 deletions(-)
 create mode 100644 org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDHoverExtensionsTest.java
 create mode 100644 org.eclipse.lsp4xml/src/test/resources/catalogs/catalog-liferay.xml
 create mode 100644 org.eclipse.lsp4xml/src/test/resources/dtd/liferay-service-builder_7_2_0.dtd

diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDAttributeDeclaration.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDAttributeDeclaration.java
index ae4e5fc69..7004b99b1 100644
--- a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDAttributeDeclaration.java
+++ b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDAttributeDeclaration.java
@@ -24,6 +24,13 @@
  */
 public class CMDTDAttributeDeclaration extends XMLAttributeDecl implements CMAttributeDeclaration {
 
+	private String documentation;
+	private CMDTDElementDeclaration elementDecl;
+
+	public CMDTDAttributeDeclaration(CMDTDElementDeclaration elementDecl) {
+		this.elementDecl = elementDecl;
+	}
+
 	@Override
 	public String getName() {
 		return super.name.localpart;
@@ -45,7 +52,11 @@ public Collection<String> getEnumerationValues() {
 
 	@Override
 	public String getDocumentation() {
-		return null;
+		if (documentation != null) {
+			return documentation;
+		}
+		documentation = elementDecl.getDocumentation(getName());
+		return documentation;
 	}
 
 	@Override
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDDocument.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDDocument.java
index 2acb45e14..a53d690d9 100644
--- a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDDocument.java
+++ b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDDocument.java
@@ -23,6 +23,7 @@
 import org.apache.xerces.impl.dtd.DTDGrammar;
 import org.apache.xerces.impl.dtd.XMLDTDLoader;
 import org.apache.xerces.xni.Augmentations;
+import org.apache.xerces.xni.XMLString;
 import org.apache.xerces.xni.XNIException;
 import org.apache.xerces.xni.grammars.Grammar;
 import org.apache.xerces.xni.parser.XMLInputSource;
@@ -43,13 +44,59 @@
  */
 public class CMDTDDocument extends XMLDTDLoader implements CMDocument {
 
+
+	static class DTDNodeInfo {
+
+		private String comment;
+
+		public DTDNodeInfo() {
+			this.comment = null;
+		}
+
+		public String getComment() {
+			return comment;
+		}
+
+		public void setComment(String comment) {
+			this.comment = comment;
+		}
+	}
+
+	static class DTDElementInfo extends DTDNodeInfo {
+
+		private final Set<String> hierarchies;
+		private final Map<String, DTDNodeInfo> attributes;
+
+		public DTDElementInfo() {
+			this.hierarchies = new LinkedHashSet<String>();
+			this.attributes = new HashMap<>();
+		}
+
+		public Set<String> getHierarchies() {
+			return hierarchies;
+		}
+
+		public Map<String, DTDNodeInfo> getAttributes() {
+			return attributes;
+		}
+
+		public String getComment(String attrName) {
+			DTDNodeInfo attr = attributes.get(attrName);
+			return attr != null ? attr.getComment() : null;
+		}
+	}
+
 	private final String uri;
 
-	private Map<String, Set<String>> hierarchiesMap;
+	private Map<String, DTDElementInfo> hierarchiesMap;
 	private List<CMElementDeclaration> elements;
 	private DTDGrammar grammar;
 	private Set<String> hierarchies;
 	private FilesChangedTracker tracker;
+	private String comment;
+	private DTDElementInfo dtdElementInfo;
+	private Map<String, DTDNodeInfo> attributes;
+	private DTDNodeInfo nodeInfo;
 
 	public CMDTDDocument() {
 		this(null);
@@ -124,23 +171,55 @@ public void startContentModel(String elementName, Augmentations augs) throws XNI
 		if (hierarchiesMap == null) {
 			hierarchiesMap = new HashMap<>();
 		}
-		hierarchies = new LinkedHashSet<String>();
-		hierarchiesMap.put(elementName, hierarchies);
+		dtdElementInfo = new DTDElementInfo();
+		if (comment != null) {
+			dtdElementInfo.setComment(comment);
+		}
+		hierarchiesMap.put(elementName, dtdElementInfo);
 		super.startContentModel(elementName, augs);
 	}
 
 	@Override
 	public void element(String elementName, Augmentations augs) throws XNIException {
+		hierarchies = dtdElementInfo.getHierarchies();
 		hierarchies.add(elementName);
 		super.element(elementName, augs);
 	}
 
 	@Override
 	public void endContentModel(Augmentations augs) throws XNIException {
+		comment = null;
 		hierarchies = null;
 		super.endContentModel(augs);
 	}
 
+	@Override
+	public void startAttlist(String elementName, Augmentations augs) throws XNIException {
+		attributes = dtdElementInfo.getAttributes();
+		super.startAttlist(elementName, augs);
+	}
+
+	@Override
+	public void attributeDecl(String elementName, String attributeName, String type, String[] enumeration,
+			String defaultType, XMLString defaultValue, XMLString nonNormalizedDefaultValue, Augmentations augs)
+			throws XNIException {
+		if (comment != null) {
+			nodeInfo = new DTDNodeInfo();
+			nodeInfo.setComment(comment);
+			attributes.put(attributeName, nodeInfo);
+		}
+		super.attributeDecl(elementName, attributeName, type, enumeration, defaultType, defaultValue, nonNormalizedDefaultValue,
+				augs);
+	}
+
+	@Override
+	public void endAttlist(Augmentations augs) throws XNIException {
+		comment = null;
+		attributes = null;
+		nodeInfo = null;
+		super.endAttlist(augs);
+	}
+
 	@Override
 	public Grammar loadGrammar(XMLInputSource source) throws IOException, XNIException {
 		grammar = (DTDGrammar) super.loadGrammar(source);
@@ -164,11 +243,24 @@ public void loadInternalDTD(String internalSubset, String baseSystemId, String s
 		fDTDScanner.scanDTDInternalSubset(true, false, systemId != null);
 	}
 
+	@Override
+	public void comment(XMLString text, Augmentations augs) throws XNIException {
+		if (text != null) {
+			comment = text.toString();
+		}
+		super.comment(text, augs);
+	}
+
+	public Map<String, DTDElementInfo> getHierarchiesMap() {
+		return hierarchiesMap;
+	}
+
 	void collectElementsDeclaration(String elementName, List<CMElementDeclaration> elements) {
 		if (hierarchiesMap == null) {
 			return;
 		}
-		Set<String> children = hierarchiesMap.get(elementName);
+		DTDElementInfo elementInfo = hierarchiesMap.get(elementName);
+		Set<String> children = elementInfo.getHierarchies();
 		if (children == null) {
 			return;
 		}
@@ -184,7 +276,7 @@ void collectAttributesDeclaration(CMDTDElementDeclaration elementDecl, List<CMAt
 		int elementDeclIndex = grammar.getElementDeclIndex(elementDecl.name);
 		int index = grammar.getFirstAttributeDeclIndex(elementDeclIndex);
 		while (index != -1) {
-			CMDTDAttributeDeclaration attributeDecl = new CMDTDAttributeDeclaration();
+			CMDTDAttributeDeclaration attributeDecl = new CMDTDAttributeDeclaration(elementDecl);
 			grammar.getAttributeDecl(index, attributeDecl);
 			attributes.add(attributeDecl);
 			index = grammar.getNextAttributeDeclIndex(index);
@@ -200,4 +292,5 @@ public LocationLink findTypeLocation(DOMNode node) {
 	public boolean isDirty() {
 		return tracker != null ? tracker.isDirty() : null;
 	}
+
 }
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDElementDeclaration.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDElementDeclaration.java
index c467d492e..3c971c500 100644
--- a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDElementDeclaration.java
+++ b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/dtd/contentmodel/CMDTDElementDeclaration.java
@@ -13,11 +13,14 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.xerces.impl.dtd.XMLElementDecl;
 import org.eclipse.lsp4xml.dom.DOMElement;
 import org.eclipse.lsp4xml.extensions.contentmodel.model.CMAttributeDeclaration;
 import org.eclipse.lsp4xml.extensions.contentmodel.model.CMElementDeclaration;
+import org.eclipse.lsp4xml.extensions.dtd.contentmodel.CMDTDDocument.DTDElementInfo;
+import org.eclipse.lsp4xml.extensions.dtd.contentmodel.CMDTDDocument.DTDNodeInfo;
 
 /**
  * DTD element declaration.
@@ -29,6 +32,7 @@ public class CMDTDElementDeclaration extends XMLElementDecl implements CMElement
 	private final CMDTDDocument document;
 	private List<CMElementDeclaration> elements;
 	private List<CMAttributeDeclaration> attributes;
+	private String documentation;
 
 	public CMDTDElementDeclaration(CMDTDDocument document, int index) {
 		this.document = document;
@@ -91,7 +95,28 @@ public CMAttributeDeclaration findCMAttribute(String attributeName) {
 
 	@Override
 	public String getDocumentation() {
-		return null;
+		if (documentation != null) {
+			return documentation;
+		}
+		Map<String, DTDElementInfo> hierarchiesMap = document.getHierarchiesMap();
+		if (hierarchiesMap != null) {
+			DTDElementInfo dtdElementInfo = hierarchiesMap.get(getName());
+			documentation = dtdElementInfo.getComment();
+		}
+		return documentation;
+	}
+
+	public String getDocumentation(String attrName) {
+		Map<String, DTDElementInfo> hierarchiesMap = document.getHierarchiesMap();
+		if (hierarchiesMap != null) {
+			DTDElementInfo dtdElementInfo = hierarchiesMap.get(getName());
+			Map<String, DTDNodeInfo> attributesMap = dtdElementInfo.getAttributes();
+			DTDNodeInfo nodeInfo = attributesMap.get(attrName);
+			if (nodeInfo != null) {
+				documentation = nodeInfo.getComment();
+			}
+		}
+		return documentation;
 	}
 
 	@Override
diff --git a/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDCompletionExtensionsTest.java b/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDCompletionExtensionsTest.java
index 290c8239b..480fae0e0 100644
--- a/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDCompletionExtensionsTest.java
+++ b/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDCompletionExtensionsTest.java
@@ -54,7 +54,10 @@ public void testCompletionDocumentationWithSource() throws BadLocationException
 				"           \"http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd\">\r\n" + //
 				"\r\n" + //
 				"  <|";
-		testCompletionFor(xml, c("catalog", te(5, 2, 5, 3, "<catalog>$1</catalog>$0"), "<catalog", "Source: catalog.dtd", MarkupKind.PLAINTEXT));
+		testCompletionFor(xml, c("catalog", te(5, 2, 5, 3, "<catalog>$1</catalog>$0"), "<catalog", " $Id: catalog.dtd,v 1.10 2002/10/18 23:54:58 ndw Exp $ "
+				+ 
+				System.lineSeparator() +
+				System.lineSeparator() + "Source: catalog.dtd", MarkupKind.PLAINTEXT));
 	}
 
 	@Test
diff --git a/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDHoverExtensionsTest.java b/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDHoverExtensionsTest.java
new file mode 100644
index 000000000..2035a0c76
--- /dev/null
+++ b/org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/extensions/contentmodel/DTDHoverExtensionsTest.java
@@ -0,0 +1,64 @@
+/**
+ *  Copyright (c) 2018 Angelo ZERR and Liferay Inc.
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v2.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v20.html
+ *
+ *  Contributors:
+ *  Angelo Zerr <angelo.zerr@gmail.com> - initial API and implementation
+ *  Seiphon Wang <seiphon.wang@liferay.com>
+ */
+package org.eclipse.lsp4xml.extensions.contentmodel;
+
+import org.apache.xerces.impl.XMLEntityManager;
+import org.apache.xerces.util.URI.MalformedURIException;
+import org.eclipse.lsp4xml.XMLAssert;
+import org.eclipse.lsp4xml.commons.BadLocationException;
+import org.eclipse.lsp4xml.services.XMLLanguageService;
+import org.junit.Test;
+
+public class DTDHoverExtensionsTest {
+
+	@Test
+	public void testTagHover() throws BadLocationException, MalformedURIException {
+		String dtdURI = getDTDFileURI("liferay-service-builder_7_2_0.dtd");
+		String xml = "<?xml version=\"1.0\"?>\r\n" + //
+				"<!DOCTYPE service-builder PUBLIC \"-//Liferay//DTD Service Builder 7.2.0//EN\" \"http://www.liferay.com/dtd/liferay-service-builder_7_2_0.dtd\">"
+				+ "<service-builder dependency-injector=\"ds\" package-path=\"testSB\"></servi|ce-builder>";
+		assertHover(xml,"The service-builder element is the root of the deployment descriptor for" + //
+				" a Service Builder descriptor that is used to generate services available to" +
+				" portlets. The Service Builder saves the developer time by generating Spring" +
+				" utilities, SOAP utilities, and Hibernate persistence classes to ease the" +
+				" development of services."
+						+ //
+						System.lineSeparator() + //
+						System.lineSeparator() + "Source: [liferay-service-builder_7_2_0.dtd](" + dtdURI + ")",
+				206);
+	}
+
+	@Test
+	public void testAttributeNameHover() throws BadLocationException, MalformedURIException {
+		String dtdURI = getDTDFileURI("liferay-service-builder_7_2_0.dtd");
+		String xml = "<?xml version=\"1.0\"?>\r\n" + //
+				"<!DOCTYPE service-builder PUBLIC \"-//Liferay//DTD Service Builder 7.2.0//EN\" \"http://www.liferay.com/dtd/liferay-service-builder_7_2_0.dtd\">"
+				+ "<service-builder dependency-injector=\"ds\" pa|ckage-path=\"testSB\"></service-builder>";
+		assertHover(xml,
+				"The package-path value specifies the package of the generated code."
+						+ //
+						System.lineSeparator() + //
+						System.lineSeparator() + "Source: [liferay-service-builder_7_2_0.dtd](" + dtdURI + ")",
+				null);
+	}
+
+	private static void assertHover(String value, String expectedHoverLabel, Integer expectedHoverOffset)
+			throws BadLocationException {
+		XMLAssert.assertHover(new XMLLanguageService(), value, "src/test/resources/catalogs/catalog-liferay.xml", null,
+				expectedHoverLabel, expectedHoverOffset);
+	}
+
+	private static String getDTDFileURI(String dtdURI) throws MalformedURIException {
+		return XMLEntityManager.expandSystemId("dtd/" + dtdURI, "src/test/resources/test.xml", true).replace("///",
+				"/");
+	}
+}
diff --git a/org.eclipse.lsp4xml/src/test/resources/catalogs/catalog-liferay.xml b/org.eclipse.lsp4xml/src/test/resources/catalogs/catalog-liferay.xml
new file mode 100644
index 000000000..849c999f7
--- /dev/null
+++ b/org.eclipse.lsp4xml/src/test/resources/catalogs/catalog-liferay.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+	<system
+		systemId="http://www.liferay.com/dtd/liferay-service-builder_7_2_0.dtd"
+		uri="../dtd/liferay-service-builder_7_2_0.dtd" />
+</catalog>
\ No newline at end of file
diff --git a/org.eclipse.lsp4xml/src/test/resources/dtd/liferay-service-builder_7_2_0.dtd b/org.eclipse.lsp4xml/src/test/resources/dtd/liferay-service-builder_7_2_0.dtd
new file mode 100644
index 000000000..6e0e72b9d
--- /dev/null
+++ b/org.eclipse.lsp4xml/src/test/resources/dtd/liferay-service-builder_7_2_0.dtd
@@ -0,0 +1,845 @@
+<!--
+<!DOCTYPE service-builder PUBLIC
+	"-//Liferay//DTD Service Builder 7.2.0//EN"
+	"http://www.liferay.com/dtd/liferay-service-builder_7_2_0.dtd">
+-->
+
+        <!--
+        The service-builder element is the root of the deployment descriptor for
+        a Service Builder descriptor that is used to generate services available to
+        portlets. The Service Builder saves the developer time by generating Spring
+        utilities, SOAP utilities, and Hibernate persistence classes to ease the
+        development of services.
+        -->
+        <!ELEMENT service-builder (author?, namespace, entity*, exceptions?,
+                service-builder-import*)>
+
+        <!--
+        The package-path value specifies the package of the generated code.
+        -->
+        <!ATTLIST service-builder
+                package-path CDATA #REQUIRED
+                >
+
+        <!--
+        The auto-import-default-references value specifies whether or not to
+        automatically default references. The default value is true.
+        -->
+        <!ATTLIST service-builder
+                auto-import-default-references CDATA #IMPLIED
+                >
+
+        <!--
+        The auto-namespace-tables value specifies whether or not to automatically
+        namespace tables. The default value is false for core services and true for
+        plugin services.
+        -->
+        <!ATTLIST service-builder
+                auto-namespace-tables CDATA #IMPLIED
+                >
+
+        <!--
+        The dependency-injector value specifies which dependency injector to use. Valid
+        values are "spring" and "ds". For new OSGi modules, the default value is "ds",
+        for existing modules or WARs, the default value is "spring".
+        -->
+        <!ATTLIST service-builder
+                dependency-injector CDATA #IMPLIED
+                >
+
+        <!--
+        The mvcc-enabled value specifies whether or not to enable MVCC by default for
+        entities to prevent lost updates. The default value is false.
+        -->
+        <!ATTLIST service-builder
+                mvcc-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The author element is the name of the user associated with the generated code.
+        -->
+        <!ELEMENT author (#PCDATA)>
+
+        <!--
+        The namespace element must be a unique namespace for this component. Table names
+        will be prepended with this namespace. Generated JSON JavaScript will be scoped
+        to this namespace as well (i.e., Liferay.Service.Test.* if the namespace is
+        Test).
+        -->
+        <!ELEMENT namespace (#PCDATA)>
+
+        <!--
+        An entity usually represents a business facade and a table in the database. If
+        an entity does not have any columns, then it only represents a business facade.
+        The Service Builder will always generate an empty business facade POJO if it
+        does not exist. Upon subsequent generations, the Service Builder will check to
+        see if the business facade already exists. If it exists and has additional
+        methods, then the Service Builder will also update the SOAP wrappers.
+
+        If an entity does have columns, then the value object, the POJO class that
+        is mapped to the database, and other persistence utilities are also generated
+        based on the order and finder elements.
+        -->
+        <!ELEMENT entity (column*, localized-entity?, order?, finder*, reference*, tx-required*)>
+
+        <!--
+        The name value specifies the name of the entity.
+        -->
+        <!ATTLIST entity
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        The human-name value specifies the readable name to use when generating
+        documentation for this entity. If none is specified, one will be generated from
+        the name.
+        -->
+        <!ATTLIST entity
+                human-name CDATA #IMPLIED
+                >
+
+        <!--
+        The table value specifies the name of the table that this entity maps to in the
+        database. If this value is not set, then the name of the table is the same as
+        the name of the entity.
+        -->
+        <!ATTLIST entity
+                table CDATA #IMPLIED
+                >
+
+        <!--
+        If the uuid value is true, then the service will generate a UUID column for the
+        service. This column will automatically be populated with a UUID. Developers
+        will also be able to find and remove based on that UUID. The default value is
+        false.
+        -->
+        <!ATTLIST entity
+                uuid CDATA #IMPLIED
+                >
+
+        <!--
+        If the uuid-accessor value is true, then the service will generate a UUID column
+        accessor for the service. This accessor will provide a fast and type-safe way to
+        access entity's UUID.
+        -->
+        <!ATTLIST entity
+                uuid-accessor CDATA #IMPLIED
+                >
+
+        <!--
+        If the external-reference-code values is true, then the service will generate a
+        externalReferenceCode column for the service. The default value is false.
+        -->
+        <!ATTLIST entity
+                external-reference-code CDATA #IMPLIED
+                >
+
+        <!--
+        If the local-service value is true, then the service will generate the local
+        interfaces for the service. The default value is false.
+        -->
+        <!ATTLIST entity
+                local-service CDATA #IMPLIED
+                >
+
+        <!--
+        If the remote-service value is true, then the service will generate remote
+        interfaces for the service. The default value is true.
+        -->
+        <!ATTLIST entity
+                remote-service CDATA #IMPLIED
+                >
+
+        <!--
+        If the persistence value is true, then the service will generate persistence
+        interfaces and database files for the service. The default value is true.
+        -->
+        <!ATTLIST entity
+                persistence CDATA #IMPLIED
+                >
+
+        <!--
+        The persistence-class value specifies the name of your custom persistence class.
+        This class must implement the generated persistence interface or extend the
+        generated persistence class. This allows you to override default behavior
+        without modifying the generated persistence class.
+        -->
+        <!ATTLIST entity
+                persistence-class CDATA #IMPLIED
+                >
+
+        <!--
+        The data-source value specifies the data source target that is set to the
+        persistence class. The default value is the Liferay data source. This is used in
+        conjunction with session-factory. See data-source-spring.xml.
+
+        You can generate classes to use a custom data source and session factory.
+        Point "spring.configs" in portal.properties to load your custom Spring XML with
+        the definitions of your custom data source and session factory. Then set the
+        data-source and session-factory values to your custom values.
+        -->
+        <!ATTLIST entity
+                data-source CDATA #IMPLIED
+                >
+
+        <!--
+        The session-factory value specifies the session factory that is set to the
+        persistence class. The default value is the Liferay session factory. This is
+        used in conjunction with data-source. See data-source-spring.xml.
+
+        You can generate classes to use a custom data source and session factory.
+        Point "spring.configs" in portal.properties to load your custom Spring XML with
+        the definitions of your custom data source and session factory. Then set the
+        data-source and session-factory values to your custom values.
+        -->
+        <!ATTLIST entity
+                session-factory CDATA #IMPLIED
+                >
+
+        <!--
+        The tx-manager value specifies the transaction manager that Spring uses. The
+        default value is the Spring Hibernate transaction manager that wraps the Liferay
+        data source and session factory. See data-source-spring.xml. Set this attribute
+        to "none" to disable transaction management.
+        -->
+        <!ATTLIST entity
+                tx-manager CDATA #IMPLIED
+                >
+
+        <!--
+        The cache-enabled value specifies whether or not to cache this queries for this
+        entity. Set this to false if data in the table will be updated by other
+        programs. The default value is true.
+        -->
+        <!ATTLIST entity
+                cache-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The dynamic-update-enabled value specifies whether or not unmodified properties
+        are excluded in the SQL update statement. The default value is the value of the
+        attribute mvcc-enabled.
+        -->
+        <!ATTLIST entity
+                dynamic-update-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The json-enabled value specifies whether or not the entity should be annotated
+        for JSON serialization. By default, if the remote-service value is true, then
+        the json-enabled value is true.
+        -->
+        <!ATTLIST entity
+                json-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The mvcc-enabled value specifies whether or not to enable MVCC for this
+        entity to prevent lost updates. The default value is based on the mvcc-enabled
+        attribute in the service-builder element.
+        -->
+        <!ATTLIST entity
+                mvcc-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The trash-enabled value specifies whether trash related methods should be
+        generated or not.
+        -->
+        <!ATTLIST entity
+                trash-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-application-name value specifies the name of the application that the
+        entity type belongs to in the GDPR UI.
+        -->
+        <!ATTLIST entity
+                uad-applicaiton-name CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-auto-delete value specifies whether or not the entity should be
+        automatically deleted during the auto-anonymization.
+        -->
+        <!ATTLIST entity
+                uad-auto-delete CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-dir-path value specifies the directory path of the generated UAD
+        implementations.
+        -->
+        <!ATTLIST entity
+                uad-dir-path CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-package-path value specifies the package path for the generated UAD
+        classes.
+        -->
+        <!ATTLIST entity
+                uad-package-path CDATA #IMPLIED
+                >
+
+        <!--
+        If the versioned value is true, then the service will generate a version table,
+        columns, and methods to version the entity.
+        -->
+        <!ATTLIST entity
+                versioned CDATA #IMPLIED
+                >
+
+        <!--
+        The deprecated value specifies whether the entity's services are deprecated.
+        -->
+        <!ATTLIST entity
+                deprecated CDATA #IMPLIED
+                >
+
+        <!--
+        The column element represents a column in the database.
+        -->
+        <!ELEMENT column (#PCDATA)>
+
+        <!--
+        The name value specifies the getter and setter name in the entity.
+        -->
+        <!ATTLIST column
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        Set db-name to map the field to a physical database column that is different
+        from the column name.
+        -->
+        <!ATTLIST column
+                db-name CDATA #IMPLIED
+                >
+
+        <!--
+        The type value specifies whether the column is a String, Boolean, or int, etc.
+
+        For example:
+
+        <column name="companyId" db-name="companyId" type="String" />
+
+        The above column specifies that there will be a getter called
+        pojo.getCompanyId() that will return a String.
+        -->
+        <!ATTLIST column
+                type CDATA #REQUIRED
+                >
+
+        <!--
+        If the primary value is set to true, then this column is part of the primary key
+        of the entity. If multiple columns have the primary value set to true, then a
+        compound key will be created.
+        -->
+        <!ATTLIST column
+                primary CDATA #IMPLIED
+                >
+
+        <!--
+        This accessor value specifies whether or not to generate an accessor for this
+        column. This accessor will provide a fast and type-safe way to access column
+        value.
+        -->
+        <!ATTLIST column
+                accessor CDATA #IMPLIED
+                >
+
+        <!--
+        The filter-primary value specifies the column to use as the primary key column
+        when using filter finders. Only one column should ever have this value set to
+        true. If no column has this set to true, then the default primary column will be
+        used.
+        -->
+        <!ATTLIST column
+                filter-primary CDATA #IMPLIED
+                >
+
+        <!--
+        If the entity and mapping-table attributes are specified, then the Service
+        Builder will assume you are specifying a many to many relationship.
+
+        For example:
+
+        <column
+            name="roles"
+            type="Collection"
+            entity="Role"
+            mapping-table="Groups_Roles"
+        />
+
+        The above column specifies that there will be a getter called
+        pojo.getRoles() that will return a collection. It will use a mapping table
+        called Groups_Roles to give a many to many relationship between groups and
+        roles.
+
+        If you are creating a mapping table for an entity defined in another
+        service.xml, you need to specify the full package path.
+
+        For example:
+
+        <column
+            name="organizations"
+            type="Collection"
+            entity="com.liferay.portal.Organization"
+            mapping-table="Foo_Organizations"
+        />
+        -->
+        <!ATTLIST column
+                entity CDATA #IMPLIED
+                >
+
+        <!--
+        See the entity attribute's description for more information.
+        -->
+        <!ATTLIST column
+                mapping-table CDATA #IMPLIED
+                >
+
+        <!--
+        The id-type and id-param values are used in order to create an auto-generated,
+        auto-incrementing primary key when inserting records into a table. This can be
+        implemented in 4 different ways, depending on the type of database being used.
+        In all cases, the primary key of the model object should be assigned a value of
+        null, and Hibernate will know to replace the null value with an auto-generated,
+        auto-incremented value. If no id-type value is used, it is assumed that the
+        primary key will be assigned and not auto-generated.
+
+        The first implementation uses a class to generate a primary key.
+
+        For example:
+
+        <column
+            name="id"
+            type="Integer"
+            primary="true"
+            id-type="class"
+            id-param="com.liferay.counter.service.persistence.IDGenerator"
+        />
+
+        In this implementation, the class specified in the id-param value will be called
+        to retrieve a unique identifier (in the example above, an Integer) that will be
+        used as the primary key for the new record. This implementation works for all
+        supported databases.
+
+        The second implementation generates identifiers that are unique only when no
+        other process is inserting data into the same table. This implementation should
+        NOT be used in a clustered environment, but it does work for all supported
+        databases.
+
+        For example:
+
+        <column
+            name="id"
+            type="Integer"
+            primary="true"
+            id-type="increment"
+        />
+
+        The third implementation uses an identity column to generate a primary key.
+
+        For example:
+
+        <column
+            name="id"
+            type="Integer"
+            primary="true"
+            id-type="identity"
+        />
+
+        In this implementation, the create table SQL generated for this entity will
+        create an identity column that natively auto-generates a primary key whenever
+        an insert occurs. This implementation is only supported by DB2, MySQL, and
+        MS SQL Server.
+
+        The fourth implementation uses a sequence to generate a primary key.
+
+        For example:
+
+        <column
+            name="id"
+            type="Integer"
+            primary="true"
+            id-type="sequence"
+            id-param="id_sequence"
+        />
+
+        In this implementation, a create sequence SQL statement is created based on
+        the id-param value (stored in /sql/sequences.sql). This sequence is then
+        accessed to generate a unique identifier whenever an insert occurs. This
+        implementation is only supported by DB2, Oracle, PostgreSQL, and SAP DB.
+        -->
+        <!ATTLIST column
+                id-type CDATA #IMPLIED
+                >
+
+        <!--
+        See the id-type attribute's description for more information.
+        -->
+        <!ATTLIST column
+                id-param CDATA #IMPLIED
+                >
+
+        <!--
+        The convert-null value specifies whether or not the column value is
+        automatically converted to a non null value if it is null. This only applies if
+        the type value is String. This is particularly useful if your entity is
+        referencing a read only table or a database view so that Hibernate does not try
+        to issue unnecessary updates. The default value is true.
+        -->
+        <!ATTLIST column
+                convert-null CDATA #IMPLIED
+                >
+
+        <!--
+        The lazy value is only valid when type is Blob. It specifies whether or not to
+        do a lazy fetch for Blob. The default value is true.
+        -->
+        <!ATTLIST column
+                lazy CDATA #IMPLIED
+                >
+
+        <!--
+        The localized value specifies whether or not the value of the column can have
+        different values for different locales. The default value is false. Localization
+        can also be performed by using a generated localization table using the
+        localized-entity and localized-column elements. The localized value cannot be
+        set to true when the entity contains a localized-entity element. Using the
+        localized-entity element with a separate table is recommended.
+        -->
+        <!ATTLIST column
+                localized CDATA #IMPLIED
+                >
+
+        <!--
+        The json-enabled value specifies whether or not the column should be annotated
+        for JSON serialization. By default, if the json-enabled value in the entity
+        element is true, then the json-enabled value in the column element is true.
+        -->
+        <!ATTLIST column
+                json-enabled CDATA #IMPLIED
+                >
+
+        <!--
+        The container-model value specifies whether the column represents the primary
+        key of a container model.
+        -->
+        <!ATTLIST column
+                container-model CDATA #IMPLIED
+                >
+
+        <!--
+        The parent-container-model value specifies whether the column represents the
+        primary key of a parent container model.
+        -->
+        <!ATTLIST column
+                parent-container-model CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-anonymize-field-name value specifies the anonymous user field that
+        should be used to replace this column's value during auto anonymization. For
+        example, if "fullName" is specified, the anonymous user's full name will replace
+        this column's value during auto anonymization. The uad-anonymize-field-name
+        value should only be used with user name columns (e.g. "statusByUserName").
+        -->
+        <!ATTLIST column
+                uad-anonymize-field-name CDATA #IMPLIED
+                >
+
+        <!--
+        The uad-nonanonymizable value specifies whether the column represents data
+        associated with a specific user that should be reviewed by an administrator in
+        the event of a GDPR compliance request. This implies the data cannot be
+        anonymized automatically.
+        -->
+        <!ATTLIST column
+                uad-nonanonymizable CDATA #IMPLIED
+                >
+
+        <!--
+        The localized-entity element represents a table with a one to many mapping from
+        the entity table to the localized entity table. The localized entity table is
+        designed to be used instead of setting a column element's localized attribute to
+        true. A defaultLanguageId column is generated for the entity table and several
+        columns, finders, and update methods are generated for the localized entity.
+        -->
+        <!ELEMENT localized-entity (column*, localized-column+, order?, finder*)>
+
+        <!--
+        The name value specifies the name of the localized entity. If this value is not
+        set, then the parent entity's name is used with "Localization" appended.
+        -->
+        <!ATTLIST localized-entity
+                name CDATA #IMPLIED
+                >
+
+        <!--
+        The table value specifies the name of the table that this localized entity maps
+        to in the database. If this value is not set, then the name of the table is the
+        same as the name of the localized entity.
+        -->
+        <!ATTLIST localized-entity
+                table CDATA #IMPLIED
+                >
+
+        <!--
+        The localized-column element represents a column in the localization table.
+        -->
+        <!ELEMENT localized-column (#PCDATA)>
+
+        <!--
+        The name value specifies the getter and setter name in the entity and
+        localization entity.
+        -->
+        <!ATTLIST localized-column
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        Set db-name to map the field to a physical database column that is different
+        from the localized-column name.
+        -->
+        <!ATTLIST localized-column
+                db-name CDATA #IMPLIED
+                >
+
+        <!--
+        The order element specifies a default ordering and sorting of the entities when
+        they are retrieved from the database.
+        -->
+        <!ELEMENT order (order-column+)>
+
+        <!--
+        Set the by attribute to "asc" or "desc" to order by ascending or descending.
+        -->
+        <!ATTLIST order
+                by CDATA #IMPLIED
+                >
+
+        <!--
+        The order-column element allows you to order the entities by specific columns.
+
+        The attributes of the order-column element allows you to fine tune the ordering
+        of the entity.
+
+        For example:
+
+        <order by="asc">
+            <order-column name="parentLayoutId" />
+            <order-column name="priority" />
+        </order>
+
+        The above settings will order by parentLayoutId and then by priority in an
+        ascending manner.
+
+        For example:
+
+        <order by="asc">
+            <order-column name="name" case-sensitive="false" />
+        </order>
+
+        The above settings will order by name and will not be case sensitive.
+
+        For example:
+
+        <order>
+            <order-column name="articleId" order-by="asc" />
+            <order-column name="version" order-by="desc" />
+        </order>
+
+        The above settings will order by articleId in an ascending manner and then by
+        version in a descending manner.
+        -->
+        <!ELEMENT order-column (#PCDATA)>
+
+        <!--
+        The name value specifies the name of the entity.
+        -->
+        <!ATTLIST order-column
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        The case-sensitive value specifies whether or not the name is case sensitive.
+        The default value is true.
+        -->
+        <!ATTLIST order-column
+                case-sensitive CDATA #IMPLIED
+                >
+
+        <!--
+        The order-by value specifies how to order the entity names. Possible values for
+        this attribute are "asc" (ascending) or "desc" (descending).
+        -->
+        <!ATTLIST order-column
+                order-by CDATA #IMPLIED
+                >
+
+        <!--
+        The finder element represents a generated finder method.
+        -->
+        <!ELEMENT finder (finder-column+)>
+
+        <!--
+        The name value specifies the name of the finder method.
+        -->
+        <!ATTLIST finder
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        The return-type value specifies the return type of the finder. Valid values are
+        "Collection" or the name of the entity. If the value is "Collection", then this
+        finder returns a list of entities. If the value is the name of the entity, then
+        this finder returns at most one entity.
+        -->
+        <!ATTLIST finder
+                return-type CDATA #REQUIRED
+                >
+
+        <!--
+        If the unique value is true, then the finder must return a unique entity.
+        -->
+        <!ATTLIST finder
+                unique CDATA #IMPLIED
+                >
+
+        <!ATTLIST finder
+                where CDATA #IMPLIED
+                >
+
+        <!--
+        If the db-index value is true, then the service will automatically generate a
+        SQL index for this finder. The default value is true.
+        -->
+        <!ATTLIST finder
+                db-index CDATA #IMPLIED
+                >
+
+        <!--
+        The finder-column element specifies the columns to find by.
+        -->
+        <!ELEMENT finder-column (#PCDATA)>
+
+        <!--
+        The name value specifies the name of the finder method.
+
+        For example:
+
+        <finder name="CompanyId" return-type="Collection">
+            <finder-column name="companyId" />
+        </finder>
+
+        The above settings will create a finder with the name findByCompanyId that will
+        return a Collection and require a given companyId. It will also generate
+        several more findByCompanyId methods that take in pagination fields (int begin,
+        int end) and more sorting options. The easiest way to understand this is to
+        look at a generated PersistenceImpl class. The Service Builder will also
+        generate removeByCompanyId and countByCompanyId.
+
+        See com.liferay.portal.service.persistence.impl.LayoutPersistenceImpl for a good
+        example.
+        -->
+        <!ATTLIST finder-column
+                name CDATA #REQUIRED
+                >
+
+        <!--
+        The attribute case-sensitive is a boolean value and is only used if the column
+        is a String value.
+        -->
+        <!ATTLIST finder-column
+                case-sensitive CDATA #IMPLIED
+                >
+
+        <!--
+        The attribute comparator takes in the values =, !=, <, <=, >, >=, or LIKE and is
+        used to compare this column.
+        -->
+        <!ATTLIST finder-column
+                comparator CDATA #IMPLIED
+                >
+
+        <!--
+        The attribute arrayable-operator takes in the values AND or OR and will
+        generate an additional finder where this column's parameter takes an array
+        instead of a single value. Every value in this array will be compared with the
+        column using the comparator, and the conditions will be combined with either an
+        AND or OR operator. For example, a finder column with the = comparator and an
+        arrayable-operator of OR will act like an IN clause.
+        -->
+        <!ATTLIST finder-column
+                arrayable-operator CDATA #IMPLIED
+                >
+
+        <!--
+        The attribute arrayable-pagination is a boolean value and is used to signal if
+        the entity column can be paginated.
+        -->
+        <!ATTLIST finder-column
+                arrayable-pagination CDATA #IMPLIED
+                >
+
+        <!--
+        The reference element allows you to inject services from another service.xml
+        within the same class loader. For example, if you inject the Resource entity,
+        then you'll be able to reference the Resource services from your service
+        implementation via the methods getResourceLocalService and getResourceService.
+        You'll also be able to reference the Resource services via the variables
+        resourceLocalService and resourceService.
+        -->
+        <!ELEMENT reference (#PCDATA)>
+
+        <!--
+        See the comments in reference element.
+        -->
+        <!ATTLIST reference
+                package-path CDATA #IMPLIED
+                entity CDATA #IMPLIED
+                >
+
+        <!--
+        The tx-required element has a text value that will be used to match method names
+        that require transactions. By default, the methods: add*, check*, clear*,
+        delete*, set*, and update* require propagation of transactions. All other
+        methods support transactions but are assumed to be read only. If you want
+        additional methods to fall under transactions, add the method name to this
+        element.
+
+        The tx-required attribute is deprecated in favor annotating the service impl
+        method with com.liferay.portal.kernel.transaction.Transactional.
+        -->
+        <!ELEMENT tx-required (#PCDATA)>
+
+        <!--
+        The exceptions element contain a list of generated exceptions. This doesn't save
+        a lot of typing, but can still be helpful.
+        -->
+        <!ELEMENT exceptions (exception*)>
+
+        <!--
+        See the comments in exceptions element.
+        -->
+        <!ELEMENT exception (#PCDATA)>
+
+        <!--
+        The service-builder-import allows you to split up a large Service Builder file
+        into smaller files by aggregrating the smaller Service Builder into one file.
+        Note that there can be at most one author element among all the files. There can
+        also only be one and only one namespace element among all the files.
+
+        The attribute file is interpreted as relative to the file that is importing it.
+        -->
+        <!ELEMENT service-builder-import (#PCDATA)>
+
+        <!--
+        Set the comments in the service-builder-import element.
+        -->
+        <!ATTLIST service-builder-import
+                file CDATA #REQUIRED
+                >
\ No newline at end of file