Class Relateds

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Deque<java.lang.String>, java.util.List<java.lang.String>, java.util.Queue<java.lang.String>

    public class Relateds
    extends java.util.LinkedList<java.lang.String>
    The relateds are specific fields in data not corresponding to persisted attributes, but possibly get from getters. If a related is present as a parameter in the query String, the corresponding accessor in the data may be invoqued and the result is included in the xml result in a related tag. Example : for a call to /rest/data/j_2?related=dataImage we would have : <data class="com.jalios.jcms.Member" id="j_2" url="jcms/j_2/admin"> <field name="author" id="j_2" class="com.jalios.jcms.Member" login="admin">Admin</field> <field name="opAuthor" id="j_2" class="com.jalios.jcms.Member" login="admin">Admin</field> <field name="cdate">2004-08-03T11:40:19+02:00</field> <field name="mdate">2009-04-20T16:35:39+02:00</field> <field name="login">admin</field> <field name="name">Admin</field> <field name="email">admin@company.com</field> <field name="isEmailVisible">false</field> <field name="info">Administrator</field> <field name="declaredGroups"> <item id="j_1" class="com.jalios.jcms.Group">Administrators</item> </field> <field name="isAdmin">true</field> <field name="useCategoryMode">0</field> <field name="language">fr</field> <field name="webdavAccess">true</field> <related name="dataImage">upload/photos/2009-04/mbr_j_2.jpg</related> </data>
    Since:
    JCMS-6.1
    Author:
    dissert
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount
    • Constructor Summary

      Constructors 
      Constructor Description
      Relateds()  
      Relateds​(java.lang.String[] relatedsKeys)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAllReferrerSet()  
      void addAllReferrerSet​(java.lang.String className)  
      void addChildrenSet()  
      void addDataImage()  
      void addExtraData​(java.lang.String extraDataName)  
      void addExtraDBData​(java.lang.String extraDBDataName)  
      void addExtraInfo​(java.lang.String extraInfoName)  
      void addIsLocked()  
      void addIsStrongLocked()  
      void addLinkCount()  
      void addLinkIndexedDataSet​(java.lang.String className)  
      void addLinkIndexedDataSet​(java.lang.String className, java.lang.String fieldName)  
      void addLockDate()  
      void addLockMember()  
      void addMemberCategoryRootSet()  
      void addStrongLockDate()  
      void addStrongLockMember()  
      void addVirtualID()  
      void addWorkspaceSet()  
      org.jdom.Element getAllReferrerSet()  
      org.jdom.Element getAllReferrerSet​(java.lang.String className)  
      org.jdom.Element getChildrenSet()  
      java.lang.String getDataImage()  
      java.lang.String getExtraData​(java.lang.String extraDataName)  
      java.lang.String getExtraDBData​(java.lang.String extraDBDataName)  
      org.jdom.Element getExtraInfo​(java.lang.String extraInfoName)  
      int getLinkCount()  
      org.jdom.Element getLinkIndexedDataSet​(java.lang.String className)  
      org.jdom.Element getLinkIndexedDataSet​(java.lang.String className, java.lang.String fieldName)  
      java.util.Date getLockDate()  
      java.lang.String getLockMemberId()  
      org.jdom.Element getMemberCategoryRootSet()  
      java.lang.String getVirtualID()  
      org.jdom.Element getWorkspaceSet()  
      • Methods inherited from class java.util.LinkedList

        add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray
      • Methods inherited from class java.util.AbstractSequentialList

        iterator
      • Methods inherited from class java.util.AbstractList

        equals, hashCode, listIterator, removeRange, subList
      • Methods inherited from class java.util.AbstractCollection

        containsAll, isEmpty, removeAll, retainAll, toString
      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray
      • Methods inherited from interface java.util.Deque

        iterator
      • Methods inherited from interface java.lang.Iterable

        forEach
      • Methods inherited from interface java.util.List

        containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList
    • Constructor Detail

      • Relateds

        public Relateds()
      • Relateds

        public Relateds​(java.lang.String[] relatedsKeys)
    • Method Detail

      • addExtraData

        public void addExtraData​(java.lang.String extraDataName)
      • addExtraDBData

        public void addExtraDBData​(java.lang.String extraDBDataName)
      • addExtraInfo

        public void addExtraInfo​(java.lang.String extraInfoName)
      • addDataImage

        public void addDataImage()
      • addLinkCount

        public void addLinkCount()
      • addVirtualID

        public void addVirtualID()
      • addAllReferrerSet

        public void addAllReferrerSet()
      • addAllReferrerSet

        public void addAllReferrerSet​(java.lang.String className)
      • addLinkIndexedDataSet

        public void addLinkIndexedDataSet​(java.lang.String className)
      • addLinkIndexedDataSet

        public void addLinkIndexedDataSet​(java.lang.String className,
                                          java.lang.String fieldName)
      • addIsLocked

        public void addIsLocked()
      • addLockMember

        public void addLockMember()
      • addLockDate

        public void addLockDate()
      • addIsStrongLocked

        public void addIsStrongLocked()
      • addStrongLockMember

        public void addStrongLockMember()
      • addStrongLockDate

        public void addStrongLockDate()
      • getExtraData

        public java.lang.String getExtraData​(java.lang.String extraDataName)
      • getExtraDBData

        public java.lang.String getExtraDBData​(java.lang.String extraDBDataName)
      • getExtraInfo

        public org.jdom.Element getExtraInfo​(java.lang.String extraInfoName)
      • getDataImage

        public java.lang.String getDataImage()
      • getLinkCount

        public int getLinkCount()
      • getLockDate

        public java.util.Date getLockDate()
      • getVirtualID

        public java.lang.String getVirtualID()
      • getAllReferrerSet

        public org.jdom.Element getAllReferrerSet()
      • getAllReferrerSet

        public org.jdom.Element getAllReferrerSet​(java.lang.String className)
      • getLinkIndexedDataSet

        public org.jdom.Element getLinkIndexedDataSet​(java.lang.String className)
      • getLinkIndexedDataSet

        public org.jdom.Element getLinkIndexedDataSet​(java.lang.String className,
                                                      java.lang.String fieldName)
      • getLockMemberId

        public java.lang.String getLockMemberId()
      • addWorkspaceSet

        public void addWorkspaceSet()
      • getWorkspaceSet

        public org.jdom.Element getWorkspaceSet()
      • addMemberCategoryRootSet

        public void addMemberCategoryRootSet()
      • getMemberCategoryRootSet

        public org.jdom.Element getMemberCategoryRootSet()
      • addChildrenSet

        public void addChildrenSet()
      • getChildrenSet

        public org.jdom.Element getChildrenSet()