/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.isis.core.metamodel.specloader.specimpl;
import java.util.List;
import com.google.common.base.Strings;
import org.apache.isis.applib.Identifier;
import org.apache.isis.applib.annotation.When;
import org.apache.isis.applib.annotation.Where;
import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
import org.apache.isis.core.metamodel.consent.Consent;
import org.apache.isis.core.metamodel.consent.InteractionInitiatedBy;
import org.apache.isis.core.metamodel.facetapi.FacetHolder;
import org.apache.isis.core.metamodel.facetapi.FacetHolderImpl;
import org.apache.isis.core.metamodel.facetapi.FacetUtil;
import org.apache.isis.core.metamodel.facets.actcoll.typeof.TypeOfFacet;
import org.apache.isis.core.metamodel.facets.actcoll.typeof.TypeOfFacetAbstract;
import org.apache.isis.core.metamodel.facets.all.named.NamedFacetInferred;
import org.apache.isis.core.metamodel.facets.members.disabled.DisabledFacet;
import org.apache.isis.core.metamodel.facets.members.disabled.DisabledFacetForContributee;
import org.apache.isis.core.metamodel.facets.propcoll.notpersisted.NotPersistedFacet;
import org.apache.isis.core.metamodel.facets.propcoll.notpersisted.NotPersistedFacetAbstract;
import org.apache.isis.core.metamodel.interactions.InteractionUtils;
import org.apache.isis.core.metamodel.interactions.UsabilityContext;
import org.apache.isis.core.metamodel.interactions.VisibilityContext;
import org.apache.isis.core.metamodel.services.ServicesInjector;
import org.apache.isis.core.metamodel.services.publishing.PublishingServiceInternal;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.specloader.SpecificationLoader;
public class OneToManyAssociationMixedIn extends OneToManyAssociationDefault implements MixedInMember2 {
/**
* The type of the mixin (providing the action), eg annotated with {@link org.apache.isis.applib.annotation.Mixin}.
*/
private final Class<?> mixinType;
/**
* The {@link ObjectActionDefault} for the action being mixed in (ie on the {@link #mixinType}.
*/
private final ObjectActionDefault mixinAction;
/**
* The domain object type being mixed in to (being supplemented).
*/
private final ObjectSpecification mixedInType;
/**
* Hold facets rather than delegate to the mixin action (different types might use layout metadata to position
* the mixin in different ways)
*/
private final FacetHolder facetHolder = new FacetHolderImpl();
private final Identifier identifier;
private static ObjectSpecification typeOfSpec(
final ObjectActionDefault objectAction,
final ServicesInjector objectMemberDependencies) {
final TypeOfFacet actionTypeOfFacet = objectAction.getFacet(TypeOfFacet.class);
final SpecificationLoader specificationLookup = objectMemberDependencies.getSpecificationLoader();
// TODO: a bit of a hack; ought really to set up a fallback TypeOfFacetDefault which ensures that there is always
// a TypeOfFacet for any mixedIn associations created from mixin actions.
Class<? extends Object> cls = actionTypeOfFacet != null? actionTypeOfFacet.value(): Object.class;
return specificationLookup.loadSpecification(cls);
}
public OneToManyAssociationMixedIn(
final ObjectActionDefault mixinAction,
final ObjectSpecification mixedInType,
final Class<?> mixinType,
final String mixinMethodName,
final ServicesInjector servicesInjector) {
super(mixinAction.getFacetedMethod(),
typeOfSpec(mixinAction, servicesInjector),
servicesInjector);
this.mixinType = mixinType;
this.mixinAction = mixinAction;
this.mixedInType = mixedInType;
//
// ensure the mixedIn collection cannot be modified, and derive its TypeOfFaccet
//
final NotPersistedFacet notPersistedFacet = new NotPersistedFacetAbstract(this) {};
final DisabledFacet disabledFacet = disabledFacet();
final TypeOfFacet typeOfFacet = new TypeOfFacetAbstract(getSpecification().getCorrespondingClass(), this, servicesInjector
.getSpecificationLoader()) {};
FacetUtil.addFacet(notPersistedFacet);
FacetUtil.addFacet(disabledFacet);
FacetUtil.addFacet(typeOfFacet);
//
// in addition, copy over facets from contributed to own.
//
// These could include everything under @Collection(...) because the
// CollectionAnnotationFacetFactory is also run against actions.
//
FacetUtil.copyFacets(mixinAction.getFacetedMethod(), facetHolder);
// adjust name if necessary
final String name = getName();
if(Strings.isNullOrEmpty(name) || name.equalsIgnoreCase(mixinMethodName)) {
String memberName = ObjectActionMixedIn.determineNameFrom(mixinAction);
FacetUtil.addFacet(new NamedFacetInferred(memberName, facetHolder));
}
// calculate the identifier
final Identifier mixinIdentifier = mixinAction.getFacetedMethod().getIdentifier();
List<String> memberParameterNames = mixinIdentifier.getMemberParameterNames();
identifier = Identifier.actionIdentifier(mixedInType.getCorrespondingClass().getName(), getId(), memberParameterNames);
}
private DisabledFacet disabledFacet() {
final DisabledFacet originalFacet = facetHolder.getFacet(DisabledFacet.class);
if( originalFacet != null &&
originalFacet.when() == When.ALWAYS &&
originalFacet.where() == Where.ANYWHERE) {
return originalFacet;
}
// ensure that the contributed association is always disabled
return new DisabledFacetForContributee("Contributed collection", this);
}
@Override
public ObjectAdapter get(
final ObjectAdapter mixedInAdapter,
final InteractionInitiatedBy interactionInitiatedBy) {
final ObjectAdapter mixinAdapter = mixinAdapterFor(mixinType, mixedInAdapter);
return getPublishingServiceInternal().withPublishingSuppressed(
new PublishingServiceInternal.Block<ObjectAdapter>() {
@Override public ObjectAdapter exec() {
return mixinAction.executeInternal(
mixinAdapter, mixedInAdapter, new ObjectAdapter[0], interactionInitiatedBy);
}
});
}
@Override
public Identifier getIdentifier() {
return identifier;
}
@Override
public String getId() {
return determineIdFrom(this.mixinAction);
}
@Override
public String getOriginalId() {
return super.getId();
}
@Override
public Consent isVisible(
final ObjectAdapter mixedInAdapter,
final InteractionInitiatedBy interactionInitiatedBy,
final Where where) {
final ObjectAdapter mixinAdapter = mixinAdapterFor(mixinType, mixedInAdapter);
final VisibilityContext<?> ic =
mixinAction.createVisibleInteractionContext(mixinAdapter, interactionInitiatedBy, where);
ic.setMixedIn(mixedInAdapter);
return InteractionUtils.isVisibleResult(this, ic).createConsent();
}
@Override
public Consent isUsable(
final ObjectAdapter mixedInAdapter,
final InteractionInitiatedBy interactionInitiatedBy,
final Where where) {
final ObjectAdapter mixinAdapter = mixinAdapterFor(mixinType, mixedInAdapter);
final UsabilityContext<?> ic =
mixinAction.createUsableInteractionContext(
mixinAdapter, interactionInitiatedBy, where);
ic.setMixedIn(mixedInAdapter);
return InteractionUtils.isUsableResult(this, ic).createConsent();
}
//region > FacetHolder
@Override
protected FacetHolder getFacetHolder() {
return facetHolder;
}
@Override
public ObjectSpecification getMixinType() {
return getSpecificationLoader().loadSpecification(mixinType);
}
//endregion
private PublishingServiceInternal getPublishingServiceInternal() {
return getServicesInjector().lookupService(PublishingServiceInternal.class);
}
}