com.nhl.link.rest.client.protocol.Include Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of link-rest-client Show documentation

Link Rest Java client

There is a newer version: 2.13

package com.nhl.link.rest.client.protocol;

import java.util.Objects;
import java.util.Optional;

import com.nhl.link.rest.client.protocol.Expression.ExpressionBuilder;

/**
 * @since 2.0
 */
public class Include extends LrcEntityRequest {

	public static IncludeBuilder path(String path) {
		return new IncludeBuilder(path);
	}

	private String path;

	// TODO: for now LR only supports 'mapBy' in nested includes. Once it is
	// supported at the root level this will have to be moved to the superclass
	protected String mapBy;

	protected Include(String path) {
		this.path = Objects.requireNonNull(path);
	}

	/**
	 * Returns true if the include is simply a path and doesn't have any
	 * addition constraints.
	 * 
	 * @return true if the include is simply a path and doesn't have any
	 *         addition constraints.
	 */
	public boolean isSimple() {
		return mapBy == null && cayenneExp == null && start <= 0 && limit <= 0
				&& (orderingMap == null || orderingMap.isEmpty());
	}

	public String getPath() {
		return path;
	}

	public Optional getMapBy() {
		return Optional.ofNullable(mapBy);
	}

	protected void setMapBy(String mapBy) {
		this.mapBy = mapBy;
	}

	public static class IncludeBuilder {

		private Include include;

		private IncludeBuilder(String path) {
			this.include = new Include(path);
		}

		public Include build() {
			return include;
		}

		public IncludeBuilder mapBy(String mapByPath) {
			include.setMapBy(mapByPath);
			return this;
		}

		public IncludeBuilder start(long start) {
			include.setStart(start);
			return this;
		}

		public IncludeBuilder limit(long limit) {
			include.setLimit(limit);
			return this;
		}

		public IncludeBuilder cayenneExp(ExpressionBuilder exp) {
			include.setCayenneExp(exp.build());
			return this;
		}

		public IncludeBuilder sort(String... properties) {

			if (properties != null) {

				Sort[] orderings = new Sort[properties.length];

				for (int i = 0; i < properties.length; i++) {
					orderings[i] = Sort.property(properties[i]);
				}

				include.addOrderings(orderings);
			}

			return this;
		}

		public IncludeBuilder sort(Sort... properties) {
			include.addOrderings(properties);
			return this;
		}
	}
}