Class Entity

    • Constructor Detail

      • Entity

        public Entity()
        Creates an empty entity.
      • Entity

        public Entity​(java.lang.String aName)
        Creates an entity with the given name.
    • Method Detail

      • getSchema

        public Schema getSchema()
        Returns the schema that owns this entity.
      • setSchema

        public void setSchema​(Schema aSchema)
        Sets the schema that owns this entity.
      • getEntity

        public Entity getEntity​(java.lang.String aName)
        Returns a named entity using entity resolver.
      • getName

        public java.lang.String getName()
        Returns the name of the entity.
      • setName

        public void setName​(java.lang.String aName)
        Sets the name of the entity.
      • getExists

        public boolean getExists()
        Returns whether entity exists in data source (has been saved and, if so, not deleted).
      • setExists

        public void setExists​(boolean aFlag)
        Sets whether entity exists in data source (has been saved and, if so, not deleted).
      • getPropertyCount

        public int getPropertyCount()
        Returns the number of properties.
      • getProperty

        public Property getProperty​(int anIndex)
        Returns the property at the given index.
      • getProperties

        public java.util.List<Property> getProperties()
        Returns the list of properties.
      • setProperties

        public void setProperties​(java.util.List<Property> theProps)
        Sets a list of properties.
      • addProperty

        public void addProperty​(Property aProperty)
        Adds a given property.
      • addProperty

        public void addProperty​(Property aProperty,
                                int anIndex)
        Adds a given property at given index.
      • addProperty

        public void addProperty​(Property... theProperties)
        Adds given properties.
      • removeProperty

        public java.lang.Object removeProperty​(int anIndex)
        Removes a property at given index.
      • removeProperty

        public int removeProperty​(Property aProperty)
        Removes the given property.
      • getProperty

        public Property getProperty​(java.lang.String aName)
        Returns the property with the given name.
      • getAttributeCount

        public int getAttributeCount()
        Returns the number of attributes.
      • getAttribute

        public Property getAttribute​(int anIndex)
        Returns the attribute at the given index.
      • getAttribute

        public Property getAttribute​(java.lang.String aName)
        Returns the attribute with the given name.
      • getRelationCount

        public int getRelationCount()
        Returns the number of relations in the entity.
      • getRelation

        public Property getRelation​(int anIndex)
        Returns the relation at the given index.
      • getRelations

        public java.util.List<Property> getRelations()
        Returns the list of relations in the entity.
      • getRelation

        public Property getRelation​(java.lang.String aName)
        Returns the relation for the given key path.
      • getAttributeSorted

        public Property getAttributeSorted​(int anIndex)
        Returns the attribute at the given index in a sorted attributes list.
      • getRelationSorted

        public Property getRelationSorted​(int anIndex)
        Returns the relation at the given index in the sorted list of relations.
      • getPrimary

        public Property getPrimary()
        Returns the primary key property.
      • getPrimaries

        public java.util.List<Property> getPrimaries()
        Returns the list of primary attributes for this entity.
      • getEntityClass

        public java.lang.Class getEntityClass()
        Returns the class that this entity represents.
      • setEntityClass

        public void setEntityClass​(java.lang.Class aClass)
        Sets the class that this entity represents.
      • getKeyPathProperty

        public Property getKeyPathProperty​(java.lang.String aKeyPath)
        Returns the property with the given name.
      • getKeyValue

        public java.lang.Object getKeyValue​(java.lang.String aKey)
        RMKey.Get implementation to return Property for key.
        Specified by:
        getKeyValue in interface RMKey.Get
      • getDescriptorKey

        public java.lang.String getDescriptorKey()
        Returns the key/key-chain to the property(s) that returns best string description of an entity instance.
      • setDescriptorKey

        public void setDescriptorKey​(java.lang.String aValue)
        Sets the key/key-chain to the property(s) that returns best string description of an entity instance.
      • getDescriptorKeyGuess

        public java.lang.String getDescriptorKeyGuess()
        Returns a guess of descriptor key (or the actual one, if set).
      • propertyChange

        public void propertyChange​(java.beans.PropertyChangeEvent anEvent)
        PropertyChangeListener implementation to forward property changes to entity property change listener.
        Specified by:
        propertyChange in interface java.beans.PropertyChangeListener
      • equals

        public boolean equals​(java.lang.Object anObj)
        Standard equals method.
        Overrides:
        equals in class java.lang.Object
      • toBytes

        @Nullable
        public byte[] toBytes()
        Returns bytes for this entity.
      • save

        public void save()
                  throws java.lang.Exception
        Saves the entity to its source.
        Throws:
        java.lang.Exception
      • delete

        public void delete()
                    throws java.lang.Exception
        Saves this entity from its source.
        Throws:
        java.lang.Exception
      • toString

        public java.lang.String toString()
        Returns a string representation of entity (its name).
        Overrides:
        toString in class RMObject