Package org.apache.ofbiz.entity.model

Class ModelKeyMap

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ModelKeyMap>
    @ThreadSafe
public final class ModelKeyMap
extends java.lang.Object
implements java.lang.Comparable<ModelKeyMap>, java.io.Serializable
    An object that models the <key-map> element.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ModelKeyMap​(java.lang.String fieldName, java.lang.String relFieldName)
      Data Constructor, if relFieldName is null defaults to fieldName
      ModelKeyMap​(org.w3c.dom.Element keyMapElement)
      XML Constructor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(ModelKeyMap other)  
      boolean equals​(java.lang.Object other)  
      java.lang.String getFieldName()
      Returns the field name.
      java.lang.String getRelFieldName()
      Returns the related entity field name.
      int hashCode()  
      static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1)  
      static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1, java.lang.String relFieldName1)  
      static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1, java.lang.String relFieldName1, java.lang.String fieldName2, java.lang.String relFieldName2)  
      static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1, java.lang.String relFieldName1, java.lang.String fieldName2, java.lang.String relFieldName2, java.lang.String fieldName3, java.lang.String relFieldName3)  
      java.lang.String toString()  
      org.w3c.dom.Element toXmlElement​(org.w3c.dom.Document document)  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ModelKeyMap

        public ModelKeyMap​(java.lang.String fieldName,
                   java.lang.String relFieldName)
        Data Constructor, if relFieldName is null defaults to fieldName

      • ModelKeyMap

        public ModelKeyMap​(org.w3c.dom.Element keyMapElement)
        XML Constructor

    • Method Detail

      • getFieldName

        public java.lang.String getFieldName()
        Returns the field name.

      • getRelFieldName

        public java.lang.String getRelFieldName()
        Returns the related entity field name.

      • makeKeyMapList

        public static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1)

      • makeKeyMapList

        public static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1,
                                                         java.lang.String relFieldName1)

      • makeKeyMapList

        public static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1,
                                                         java.lang.String relFieldName1,
                                                         java.lang.String fieldName2,
                                                         java.lang.String relFieldName2)

      • makeKeyMapList

        public static java.util.List<ModelKeyMap> makeKeyMapList​(java.lang.String fieldName1,
                                                         java.lang.String relFieldName1,
                                                         java.lang.String fieldName2,
                                                         java.lang.String relFieldName2,
                                                         java.lang.String fieldName3,
                                                         java.lang.String relFieldName3)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • toXmlElement

        public org.w3c.dom.Element toXmlElement​(org.w3c.dom.Document document)

      • compareTo

        public int compareTo​(ModelKeyMap other)
        Specified by:
        compareTo in interface java.lang.Comparable<ModelKeyMap>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object