Class SQLTemplateMetadata

    • Constructor Detail

      • SQLTemplateMetadata

        public SQLTemplateMetadata()
    • Method Detail

      • getCacheKey

        public String getCacheKey()
        Description copied from interface: QueryMetadata
        Returns a String that uniquely identifies this query for the purposes of result caching. If null is returned, no caching is performed.
        Specified by:
        getCacheKey in interface QueryMetadata
        Since:
        1.2
      • getDataMap

        public DataMap getDataMap()
        Description copied from interface: QueryMetadata
        Returns a DataMap associated with a query or null if no such DataMap exists.
        Specified by:
        getDataMap in interface QueryMetadata
        Since:
        1.2
      • getProcedure

        public Procedure getProcedure()
        Description copied from interface: QueryMetadata
        Returns a Procedure associated with a query or null if no such procedure exists.
        Specified by:
        getProcedure in interface QueryMetadata
        Since:
        1.2
      • getDbEntity

        public DbEntity getDbEntity()
        Description copied from interface: QueryMetadata
        Returns a DbEntity associated with a query or null if no such entity exists.
        Specified by:
        getDbEntity in interface QueryMetadata
        Since:
        1.2
      • getObjEntity

        public ObjEntity getObjEntity()
        Description copied from interface: QueryMetadata
        Returns an ObjEntity associated with a query or null if no such entity exists.
        Specified by:
        getObjEntity in interface QueryMetadata
        Since:
        1.2
      • getCacheGroup

        public String getCacheGroup()
        Description copied from interface: QueryMetadata
        Returns an optional cache "group". Cache groups allow to invalidate query caches in bulk on different events.
        Specified by:
        getCacheGroup in interface QueryMetadata
        Since:
        4.0
      • setCacheGroup

        public void setCacheGroup​(String group)
        Since:
        4.0
      • isFetchingDataRows

        public boolean isFetchingDataRows()
        Description copied from interface: QueryMetadata
        Returns true if this query should produce a list of data rows as opposed to DataObjects, false for DataObjects. This is a hint to QueryEngine executing this query.
        Specified by:
        isFetchingDataRows in interface QueryMetadata
      • getFetchLimit

        public int getFetchLimit()
        Description copied from interface: QueryMetadata
        Returns the limit on the maximum number of records that can be returned by this query. If the actual number of rows in the result exceeds the fetch limit, they will be discarded. One possible use of fetch limit is using it as a safeguard against large result sets that may lead to the application running out of memory, etc. If a fetch limit is greater or equal to zero, all rows will be returned.
        Specified by:
        getFetchLimit in interface QueryMetadata
        Returns:
        the limit on the maximum number of records that can be returned by this query
      • getPageSize

        public int getPageSize()
        Description copied from interface: QueryMetadata
        Returns query page size. Page size is a hint to Cayenne that query should be performed page by page, instead of retrieving all results at once. If the value returned is less than or equal to zero, no paging should occur.
        Specified by:
        getPageSize in interface QueryMetadata
      • getOriginatingQuery

        public Query getOriginatingQuery()
        Description copied from interface: QueryMetadata
        Returns a query that originated this query. Originating query is a query whose result is needed to obtain the result of the query owning this metadata. Most often than not the returned value is null. One example of non-null originating query is a query for a range of objects in a previously fetched paginated list. The query that fetched the original paginated list is an "originated" query. It may be used to restore a list that got lost due to a cache overflow, etc.
        Specified by:
        getOriginatingQuery in interface QueryMetadata
        Since:
        4.0
      • getFetchOffset

        public int getFetchOffset()
        Description copied from interface: QueryMetadata
        Specifies a start of a range when fetching a subset of records.
        Specified by:
        getFetchOffset in interface QueryMetadata
        Since:
        3.0