com.sap.cds.ql.cqn.transformation.CqnHierarchySubsetTransformation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cds4j-api Show documentation

CDS4J API

There is a newer version: 3.6.1

/************************************************************************
 * © 2023-2024 SAP SE or an SAP affiliate company. All rights reserved. *
 ************************************************************************/
package com.sap.cds.ql.cqn.transformation;

import java.util.List;

import com.google.common.annotations.Beta;

@Beta
public interface CqnHierarchySubsetTransformation extends CqnHierarchyTransformation {

	/**
	 * Returns the transformations, which are applied to the input set before the
	 * ancestors/descendants are determined.
	 * 
	 * Typically, a {@link CqnFilterTransformation filter} or a
	 * {@link CqnSearchTransformation search} transformation is applied.
	 * 
	 * @return the transformations
	 */
	List transformations();

	/**
	 * Returns the maximum distance between start nodes and ancestors or descendants
	 * 
	 * @return the maximum distance between start nodes and ancestors or descendants
	 */
	int distanceFromStart();

	/**
	 * Returns whether the start nodes, i.e. the nodes after applying the
	 * {@link #transformations() transformations}, should be included
	 * 
	 * @return {@code true}, if the start nodes should be include; {@code false},
	 *         otherwise
	 */
	boolean keepStart();
}